sequences

Create a new step for a sequence

Add a step to the sequence. A step belongs to a <code>channel</code> (Email, LinkedIn, Task, Call, Whatsapp) and has at least one variant (up to 26 for A/B testing on Email).

<strong>Required</strong><code>channel</code>, <code>absoluteDays</code> (1–999; each day can hold at most one Email step), and <code>variants[]</code> with a <code>payload</code> shape that depends on the channel.

<strong>Optional</strong><code>priority</code> (1=Urgent … 4=Low) and <code>assigneeId</code> for task-generating steps; <code>attachmentIds</code> and <code>taskNote</code> per variant. See OpenAPI.md.

post/v1/sequences/{sequenceId}/steps

Path parameters

sequenceIdstring required

The ID of the sequence to which the step will be added

Request body

type'Email' | 'LinkedInConnectionRequest' | 'LinkedInMessage' | 'LinkedInInMail' | 'LinkedInViewProfile' | 'LinkedInPostInteration' | 'Custom' | 'CallIntroduction' | 'CallDemo' | 'CallFollowUp' | 'CallReminder' | 'CallOther' | 'WhatsappMessage' | 'WhatsappVoiceMessage' | 'WhatsappVoiceCall' required

The task 'type' of step that will be created

priority'Urgent' | 'High' | 'Normal' | 'Low'

Priority of the tasks that will be generated by this step, default is NORMAL

assigneeIdstring

User ID of the assignee who will be assigned the tasks generated by this step, default = User ID of sequence owner

absoluteDaysnumber required

The absolute number of days for the sequence step.

Example request

{
  "assigneeId": "z6R8Mw4vBn",
  "variants": [
    {
      "payload": {
        "subject": "Quick question, {{firstName}}",
        "content": "<p>Hi {{firstName}},</p><p>Hope you're doing well — wanted to reach out about {{companyName}}.</p><p>Best,<br/>Vatsal</p>",
        "preheader": "Quick question about your team"
      },
      "attachmentIds": [
        "lN5xKp2vJq"
      ]
    }
  ],
  "absoluteDays": 3
}

Response

Sequence step created successfully

idstring

Unique identifier for the step in the sequence

namestring

Name of the step in the sequence

numbernumber

Step number in the sequence

typenumber

Type of the step

absoluteDaysnumber

Absolute days for the step

Example response

{
  "id": "bwOLEx4l8G",
  "name": "Step 1",
  "number": 1,
  "type": 1,
  "absoluteDays": 3
}

Changes

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