Skip to main content
POST
Propose a sequence and tailor its campaign

Authorizations

X-API-Key
string
header
required

Body

application/json

What New sequence asks before anything is made: who to write to, who sends, what for.

table_id
string<uuid>
required

The audience's table.

campaign_key
string | null

A campaign from the library to run, by key (see the outbound presets' campaigns). Omitted, tailoring chooses the one that fits the audience best.

Maximum string length: 64
intent
string
default:""

What the campaign is for, in the person's own words: an event, a launch, an offer, who to reach. The one part of a campaign an email may state as fact.

Maximum string length: 500
record_ids
string<uuid>[] | null

Chosen rows, when the audience is those rows only.

Required array length: 1 - 1000 elements
sender_profile_ids
string<uuid>[]

The sender profiles it sends from; each email is written as its sender.

Maximum array length: 100
view_id
string<uuid> | null

A saved view narrowing the audience; null is the whole table.

Response

Successful Response

A sequence not made yet, and how its tailoring stands.

campaign
SequenceProposalCampaignSchema · object | null
required

The tailored campaign; null means the sequence starts on the standard one.

id
string<uuid>
required
in_flight
boolean
required

Tailoring is still working; poll until false.

intent
string
required
reason
string | null
required

Why it was skipped or failed, as a code.

record_count
integer | null
required

How many chosen rows, when rows were chosen.

sender_profile_ids
string<uuid>[]
required
sequence_id
string<uuid> | null
required

The sequence made from it, once made.

stage
string | null
required

While in flight: starting, choosing (the campaign) or checking (it).

status
string | null
required

The tailoring's outcome once settled: ready_for_review (a campaign is ready), kept_stock (the standard read better), skipped or failed.

table_id
string<uuid>
required
table_name
string
required
view_id
string<uuid> | null
required