Render the email for one recipient (personalization, links)

POST

/api/v1/workspaces/{workspace}/campaigns/{campaignId}/preview

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "contactId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "editing": "example", "html": "example", "language": "example", "preheader": "example", "sample": "contact", "subject": "example", "variant": "A" }'

• Your ReputeCast public URL

Permission: campaigns:view

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

campaignId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

contactId

string format: uuid

editing

string

<= 16 characters

html

string

<= 2500000 characters

language

string

<= 16 characters

preheader

string

<= 500 characters

sample

string

default: contact

Allowed values: contact no_first_name random

subject

string

<= 998 characters

variant

string

Allowed values: A B C

Responses

200

OK

Media typeapplication/json

object

contact

object

email

required

string

id

string

label

required

string

language

required

string

name

required

string

fromEmail

required

string

fromName

required

string

html

required

string

language

required

string

languageReason

required

string

missingFirstName

integer format: int64

preheader

required

string

problems

required

Array<object>

object

line

required

integer format: int64

message

required

string

renderedAt

required

string format: date-time

subject

required

string

text

required

string

tokens

required

Array<object>

object

fallbackUsed

required

boolean

key

required

string

perRecipient

required

A link filled in per recipient at send time

boolean

token

required

string

value

required

string

Example

{
  "tokens": [
    {
      "token": "{{ first_name | default: \"there\" }}"
    }
  ]
}

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