The Sponsor block of a campaign: its booking, creative and content

GET

/api/v1/workspaces/{workspace}/campaigns/{id}/sponsor-block

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sponsor-block?layout=logo-left&label=plain"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sponsor-block?layout=logo-left&label=plain';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sponsor-block?layout=logo-left&label=plain' \
  --header 'Authorization: Bearer <token>'

Permission: campaigns:view

The price shows only to people who hold earn:view.

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

required

The campaign’s id

string format: uuid

The campaign’s id

Query Parameters

layout

The block’s layout

string

Allowed values: logo-left image-top text ""

The block’s layout

label

Plain “Sponsored”, or “Sponsored by” the sponsor

string

Allowed values: plain name ""

Plain “Sponsored”, or “Sponsored by” the sponsor

Responses

200

application/json

object

bookingId

string

bookingStatus

string

Allowed values: hold booked sent ""

canSeePrice

required

boolean

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

currency

string

hash

required

string

helpers

required

Array<string>

initials

string

issue

integer format: int64

issueOn

string format: date-time

label

required

string

labelMode

required

string

Allowed values: plain name

layout

required

string

Allowed values: logo-left image-top text

link

required

string

listName

string

mjml

required

string

priceCents

integer format: int64

slotId

string

slotName

string

sponsor

string

state

required

string

Allowed values: ready waiting none

Example

{
  "bookingStatus": "hold",
  "labelMode": "plain",
  "layout": "logo-left",
  "state": "ready"
}

default

Error

application/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"
}