Skip to content

Trigger Audience Pipeline

POST
/campaigns/{campaign_id}/audience-pipeline/trigger

SPENDS CREDITS. Starts the pipeline from the targeting document as it is now.

Clears any filters previously accepted for this campaign so they are re-extracted from the (possibly edited) document, then dispatches the run: list, intent keywords, bulk enrichment - which spends credits per contact with no ceiling but the list size. 422 when the campaign has no targeting document with structured data. Poll status for progress.

Authorizations

Parameters

Path Parameters

campaign_id
required

Campaign id or slug; resolved inside the key’s organisation.

string

Campaign id or slug; resolved inside the key’s organisation.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

The app’s answer to a trigger: {"status": "started", "chain_id": ..., "campaign_id": ...}.

object
campaign_id
required
string
chain_id
Any of:
string
status
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
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