Skip to content

Create Programmatic Campaign

POST
/programmatic-campaigns

Create a programmatic campaign from a template page and a source. FREE.

Nothing is generated yet - POST /{id}/preview renders one row, and POST /{id}/generate renders them all. created_by is the key’s principal.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A template landing page plus a data source: one page per source row.

object
data_source_id
Any of:
string
data_source_name
Any of:
string
data_source_type
string
default: list
Allowed values: list workbench csv seo_import
list_id
Any of:
integer
name
required
string
settings
Any of:
object
key
additional properties
any
slug_template
string
default: {{company}}-{{first_name}}
template_page_id
required

A landing page with HTML, from GET /landing-pages.

string
variable_config
Any of:
Array<object>
object
key
additional properties
any

Responses

201

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