Sign in
sequences

Create a new sequence

Create a new sequence with a <code>title</code>. Optionally attach one or more sending email accounts via <code>emailAccountIds</code> and/or assign a schedule in the same call.

<strong>Upfront validation (all-or-nothing)</strong> — every <code>emailAccountIds</code> entry and <code>scheduleId</code> are validated before the sequence is created. If <em>any</em> 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 <strong>no sequence is created</strong>. If <code>emailAccountIds</code> is omitted, the caller's default email account is attached automatically.

post/v1/sequences

Request body

titlestring required
emailAccountIdsstring[]

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.

scheduleIdstring

Hashed ID of the sending schedule to assign to the sequence.

Example request

{
  "emailAccountIds": [
    "1Gz3xlNwr9",
    "ajzR8xpPAq"
  ]
}

Response

Sequence created successfully

messagestring

Response message indicating the status of the operation

Example response

{
  "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": "john.doe@example.com"
    }
  }
}

Changes

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