Skip to content

Preview Signature Campaign

POST
/signatures/campaigns/preview

Render a campaign banner and, optionally, test who it would reach.

Reads only. With mailbox_id set, matching explains whether the campaign would apply to that sender and the supplied recipients, and which campaign wins on priority.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Render a campaign banner without saving it, optionally against a mailbox.

object
campaign_id
Any of:
string format: uuid
data
required

A time-boxed banner campaign injected into managed signatures.

object
block
required
object
id
required
string
/^[a-zA-Z0-9_-]{1,64}$/
image
string
"" <= 2048 characters
kind
required
string
Allowed values: identity contact photo logo social cta banner divider disclaimer green_footer custom_html
locked
boolean
required
boolean
text
string
"" <= 10000 characters
url
string
"" <= 2048 characters
departments
Array<string>
<= 1000 items
ends_at
required
string format: date-time
excluded_domains
Array<string>
<= 1000 items
external_only
boolean
default: true
mailbox_ids
Array<integer>
<= 10000 items
name
required
string
>= 1 characters <= 150 characters
native_static
boolean
priority
integer
>= -1000 <= 1000
recipient_domains
Array<string>
<= 1000 items
recipient_list_ids
Array<integer>
<= 1000 items
starts_at
required
string format: date-time
status
string
default: draft
Allowed values: draft scheduled paused
mailbox_id
Any of:
integer
recipients

Candidate recipient addresses to test the targeting rules against.

Array<string>
<= 100 items
version

Revision you last read. Ignored on create.

integer

Responses

200

Successful Response

object
data
required
object
html
required
string
matching
Any of:
object
key
additional properties
any
native_static
required
boolean
plain
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string