Create Sequence
POST /v1/sequences
/v1/sequencesCreate a new sequence
Create a new sequence with a title. Optionally attach one or more sending email accounts via emailAccountIds and/or assign a schedule in the same call.
Upfront validation (all-or-nothing) — every emailAccountIds entry and scheduleId are validated before the sequence is created. If any hashed ID fails to decode, does not belong to the caller, refers to an inactive email account, or if the array would exceed the per-sequence email account limit or plan quota, the request is rejected with the corresponding error and no sequence is created. If emailAccountIds is omitted, the caller's default email account is attached automatically.
Authorization
x-api-key<token>
API key for Open API authentication
In: header
Request Body
application/jsonRequiredtitlestring
emailAccountIdsarray<string>
Array of hashed email account IDs to attach as senders of the sequence. If any ID is invalid, inactive, or exceeds the account limit, the entire request is rejected and no sequence is created.
Example:["1Gz3xlNwr9","ajzR8xpPAq"]scheduleIdstring
Hashed ID of the sending schedule to assign to the sequence.
Responses
{
"message": "Sequence created successfully",
"payload": {
"id": "JA5YdAr9wy",
"title": "Sample Sequence",
"active": true,
"steps": [
{
"id": "bwOLEx4l8G",
"name": "Step 1"
}
],
"client": {
"id": "g9bzZq4aMd",
"companyName": "Demo",
"firstName": "John",
"lastName": "Doe"
},
"user": {
"id": 1,
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]"
}
}
}