Configure Sequence

put

https://api.senderpools.com/api/{accountId}/{workspaceId}/icp/{icpId}/setup-campaign-structure

Sets how many emails the ICP sends and how each step produces its copy. Send one entry in emailConfigs per step, indexed from 0, with numEmailsToSend matching the array length.

A step is AI, where Sender Pools writes the copy for each prospect from the ICP's positioning and pitch config (a default pitch config is set if the ICP has none, see Set Pitch Config), TEMPLATE, where it sends the email templates you write with Create Email Template, or PER_CONTACT, where it renders the copy you supply for each prospect on Import Contacts. A TEMPLATE step with no active templates cannot render, so create the templates as part of the same setup.

Shortening a sequence discards the configuration of every step at or beyond the new length, along with its templates. Emails already sent are unaffected.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

Get this from Settings > Workspaces. Starts with "account_".

workspaceId

string

required

Get this from Settings > Workspaces > Workspace ID column. On read endpoints you may also pass the literal value all to span every workspace in the account.

icpId

string

required

ICP id. Get it from List ICPs or the ICPs page in the dashboard.

Body Params

numEmailsToSend

integer

required

1 to 4

Emails in the sequence. Must equal the length of emailConfigs.

emailConfigs

array of objects

required

length between 1 and 4

One entry per step. The emailIndex values must run from 0 upwards with no gaps.

emailConfigs*

emailIndex

integer

required

0 to 3

Position in the sequence, zero-based.

type

string

enum

required

How a step produces its copy. AI writes it per prospect from the ICP's positioning and pitch config (see "AI copy and pitch configs" in the introduction). TEMPLATE sends the email templates you write. PER_CONTACT renders the copy supplied for each prospect on Import Contacts (contacts[].emails).

Allowed:

delayDaysOverride

integer | null

1 to 10

Days to wait after the previous step before this one sends. Omit to leave any existing override untouched; null clears it so the ICP's minimumDaysBetweenSends applies. Ignored on step 0.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated ICP and the configuration of every step