Skip to content

Generate Campaign Ideas Async

POST
/campaigns/generate-ideas-async

The same generation, dispatched to the background. SPENDS CREDIT.

Returns a task id immediately. The spend is committed by this call even though the ideas are not here yet - cancelling the poll does not cancel the run.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

The same generation, run in the background. SPENDS CREDIT.

Returns a task id immediately. num_ideas is the cost multiplier.

object
audience_list_id
Any of:
integer
audience_source
Any of:
string
campaign_goal
required
string
campaign_type
Any of:
string
execution_targets
Any of:
Array<string>
num_ideas
Any of:
integer
organization_id
required

Ignored for tenancy. The organisation is the API key’s own.

string
persona_mode
Any of:
string
preferred_channels
Any of:
Array<string>
target_personas
Any of:
Array<string>
user_direction
Any of:
string
website_url
required
string

Responses

202

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