Skip to content

Preview Campaign Document Manifest

POST
/campaigns/document-manifest/preview

Which documents a campaign with these channels would generate. FREE.

A dry run of the generation contract: nothing is created and no model runs. The same answer POST /campaigns acts on.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Preview which documents a campaign would generate. Spends nothing.

object
audience_source
Any of:
string
campaign_focus
Any of:
string
channels
required
Array<string>
execution_targets
Any of:
Array<string>

Responses

200

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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