Skip to main content
POST
Tailor the sequence to its audience

Authorizations

X-API-Key
string
header
required

Path Parameters

sequence_id
string<uuid>
required

Body

application/json

What a person asks of a tailoring: their own words, a campaign, and brief lines to keep.

angle
string | null

The idea the campaign is built around, as the person wants it kept.

Required string length: 1 - 300
audience
string | null

Who the campaign writes to, as the person wants it kept.

Required string length: 1 - 300
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
why_now
string | null

Why this audience needs it now, as the person wants it kept.

Required string length: 1 - 300

Response

Successful Response

Where a sequence's tailoring stands: the campaign it runs, and its newest job.

campaign
SequenceCampaignReadSchema · object | null
required

The campaign a sequence runs and the brief tailoring wrote for its audience.

in_flight
boolean
required

A job is still working; launch waits for it.

job
SequenceTailoringJobReadSchema · object | null
required

One tailoring job: how far it got and what it chose.