Sequences

Create Sequence Step

POST /v1/sequences/{sequenceId}/steps

POST/v1/sequences/{sequenceId}/steps
POST
/v1/sequences/{sequenceId}/steps

Create a new step for a sequence

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

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

Optionalpriority (1=Urgent … 4=Low) and assigneeId for task-generating steps; attachmentIds and taskNote per variant. See OpenAPI.md.

Authorization

x-api-key<token>

API key for Open API authentication

In: header

Request Body

application/jsonRequired

typestring

The task 'type' of step that will be created

Example: 1Value in: "Email" | "LinkedInConnectionRequest" | "LinkedInMessage" | "LinkedInInMail" | "LinkedInViewProfile" | "LinkedInPostInteration" | "Custom" | "CallIntroduction" | "CallDemo" | "CallFollowUp" | "CallReminder" | "CallOther" | "WhatsappMessage" | "WhatsappVoiceMessage" | "WhatsappVoiceCall"

prioritystring

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

Example: 3Value in: "Urgent" | "High" | "Normal" | "Low"

assigneeIdstring

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

Example: "z6R8Mw4vBn"

variantsarray<object>

An array of variants for the sequence step. Email steps support up to 26 variants (A/B testing); other channels use a single variant. The payload shape depends on the step channel — see examples in OpenAPI.md.

Email (type=1): payload = &#123; subject, content, preheader? &#125;. taskNote is NOT allowed (Email is automated, not task-based). LinkedIn / Call / Task / WhatsApp (type=2,3,4,9,11-18): taskNote is allowed (these channels generate a task).

Example: [{"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"]}]

absoluteDaysnumber

The absolute number of days for the sequence step.

Example: 3Minimum: 1Maximum: 999

Path Parameters

sequenceIdstring

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

Responses

201
Sequence step created successfully
{
  "id": "bwOLEx4l8G",
  "name": "Step 1",
  "number": 1,
  "type": 1,
  "absoluteDays": 3
}

Request

curl -X POST \
  "https://open-api.saleshandy.com/v1/sequences/{sequenceId}/steps" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": 1,
  "priority": 3,
  "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

No response body