sequences
mcp-searchable-tool

Propose a sequence and tailor its campaign

The first half of making a sequence the way New sequence does: choose the table (or a saved view of it, or chosen rows) and who sends it, and the library campaign that fits those people is chosen, its steps' instructions rewritten for the company and its goal chosen, in the background, about a minute, BEFORE anything is made. Pass the person's own words about what it is for as intent, or a campaign_key to run a particular campaign. Poll the proposal until in_flight is false, then create the sequence with POST /sequences/ and proposal_id (and goal, to change it). Free, up to a daily number of tailorings per workspace; a proposal over it, or with no business context to tailor from, answers at once with the reason and still makes a sequence on the standard campaign.

post/sequences/proposals/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/sequences/proposals/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

campaign_keystring nullable

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

intentstring

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.

record_idsstring[] nullable

Chosen rows, when the audience is those rows only.

sender_profile_idsstring[]

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

table_idstring uuid required

The audience's table.

view_idstring uuid nullable

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

Response

Successful Response

idstring uuid required
in_flightboolean required

Tailoring is still working; poll until false.

intentstring required
reasonstring nullable required

Why it was skipped or failed, as a code.

record_countinteger nullable required

How many chosen rows, when rows were chosen.

sender_profile_idsstring[] required
sequence_idstring uuid nullable required

The sequence made from it, once made.

stagestring nullable required

While in flight: starting, choosing (the campaign) or writing (its steps for the company).

statusstring nullable required

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

table_idstring uuid required
table_namestring required
view_idstring uuid nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.