Skip to content
ReputeCastReputeCast Docs

Save the creative: logo or image, headline, text, button and link

PUT
/api/v1/workspaces/{workspace}/sponsor-bookings/{id}/creative
curl --request PUT \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/sponsor-bookings/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/creative \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "button": "example", "headline": "example", "image": "example", "link": "example", "logo": "example", "text": "example", "utm": { "campaign": "example", "medium": "example", "source": "example" } }'

Permission: sponsors:manage

ReputeCast adds the UTM parameters to the link; the click token is never added to sponsor links.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

id
required

Id

string format: uuid

Id

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
button
string
<= 40 characters
headline
string
<= 120 characters
image
string
<= 1000 characters
link
string
<= 1000 characters
logo
string
<= 1000 characters
text

Up to 280 characters.

string
<= 1000 characters
utm
required
object
campaign
string
<= 100 characters
medium
string
<= 100 characters
source
string
<= 100 characters

Example generated

{
  "button": "example",
  "headline": "example",
  "image": "example",
  "link": "example",
  "logo": "example",
  "text": "example",
  "utm": {
    "campaign": "example",
    "medium": "example",
    "source": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
activity
required
Array<object>
object
actor
string
at
required
string format: date-time
data
required
object
key
additional properties
kind
required
string
campaign
object
at
string format: date-time
author
string
byHand
required
boolean
id
required
string
name
required
string
status
required
string
canManage
required
boolean
canShare
required
boolean
canceledAt
string format: date-time
creative
required
object
button
string
<= 40 characters
headline
string
<= 120 characters
image
string
<= 1000 characters
link
string
<= 1000 characters
logo
string
<= 1000 characters
text

Up to 280 characters.

string
<= 1000 characters
utm
required
object
campaign
string
<= 100 characters
medium
string
<= 100 characters
source
string
<= 100 characters
creativeDue
string format: date-time
creativeStatus
required
string
Allowed values: waiting ready
currency
required
string
helpers
required
Array<string>
holdUntil
string format: date-time
id
required
string
issue
required
integer format: int64
issueOn
required
string format: date-time
label
required
string
library
required
Array<object>
object
id
required
string
initials
required
string
logoUrl
string
name
required
string
listName
required
string
notes
required
string
payment
required
object
due
string format: date-time
note
required
string
paidCents
integer format: int64
paidOn
string format: date-time
recordedAt
string format: date-time
recordedBy
string
status
required
string
Allowed values: unpaid paid overdue
placement
required
string
priceCents
required
integer format: int64
proposal
object
agent
required
string
at
required
string format: date-time
id
required
string
note
required
string
priceCents
required
integer format: int64
sponsor
object
id
required
string
initials
required
string
logoUrl
string
name
required
string
readyAt
string format: date-time
report
object
bookingId
required
string
clickRate
required
number format: double
clickToOpen
required
number format: double
clicks
required
integer format: int64
creative
required
object
button
string
<= 40 characters
headline
string
<= 120 characters
image
string
<= 1000 characters
link
string
<= 1000 characters
logo
string
<= 1000 characters
text

Up to 280 characters.

string
<= 1000 characters
utm
required
object
campaign
string
<= 100 characters
medium
string
<= 100 characters
source
string
<= 100 characters
delivered
required
integer format: int64
final
required
boolean
finalAt
string format: date-time
humanOpenRate
required
number format: double
humanOpens
required
integer format: int64
initials
required
string
issue
required
integer format: int64
issueOn
required
string format: date-time
label
required
string
linkCampaign
required
string
linkHost
required
string
links
required
Array<object>
object
clicks
required
integer format: int64
kind
required
string
Allowed values: button logo link
label
required
string
share
required
number format: double
listName
required
string
placement
required
string
sentAt
string format: date-time
slotName
required
string
sponsor
required
string
sponsorName
required
string
uniqueClickers
required
integer format: int64
visibility
string
shares
required
Array<object>
object
createdAt
required
string format: date-time
createdBy
required
string
every
required
boolean
expiresAt
string format: date-time
id
required
string
lastViewedAt
string format: date-time
url
string
views
required
integer format: int64
slotId
required
string
slotName
required
string
slotPriceCents
required
integer format: int64
sponsor
object
bookedCents
required
integer format: int64
clickRate
number format: double
clickRateIssue
integer format: int64
contactEmail
required
string
contactName
required
string
currency
required
string
hold
required
Array<integer>
holdCents
required
integer format: int64
id
required
string
initials
required
string
issues
required
Array<integer>
logoUrl
required
string
name
required
string
notes
required
string
paidCents
required
integer format: int64
termsDays
required
integer format: int64
website
required
string
status
required
string
Allowed values: proposed hold booked sent canceled

Example 

{
  "creativeStatus": "waiting",
  "payment": {
    "status": "unpaid"
  },
  "report": {
    "links": [
      {
        "kind": "button"
      }
    ]
  },
  "status": "proposed"
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0