Sign in
sequences

Update a step variant for a sequence

Update the <code>payload</code>, <code>status</code>, <code>taskNote</code>, <code>priority</code>, <code>assigneeId</code>, or <code>attachmentIds</code> of an existing variant. The <code>payload</code> shape must match the step's channel (see OpenAPI.md).

patch/v1/sequences/{sequenceId}/steps/{stepId}/variants/{variantId}

Path parameters

sequenceIdstring required

The ID of the sequence

stepIdstring required

The ID of the step

variantIdstring required

The ID of the variant

Request body

status0 | 1

Variant status: 0 = Inactive (paused), 1 = Active.

taskNotestring

Task note for the variant. NOT allowed on Email variants (type=1) — edge rejects it because Email is automated, not task-based. Use for LinkedIn / Call / Task / WhatsApp channels.

payloadobject

Payload for the variant. Shape must match the step's channel — see OpenAPI.md (Email: {subject, content, preheader?}, LinkedInConnectionRequest: {connectionNote}, LinkedInMessage: {message}, LinkedInInMail: {subject, message}, ViewProfile/PostInteraction/Task/Call/Whatsapp: {}).

absoluteDaysnumber

Override day number for this variant (1–999). Each day can hold at most one Email step.

attachmentIdsstring[]

Full replacement of the attachment list for this variant (Email variants only). Pass [] to remove all attachments. Upload attachments via POST /v1/attachments to obtain an ID.

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

Hashed user ID to assign generated tasks to (task-based channels). Defaults to the sequence owner.

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

Task priority (1=Urgent, 2=High, 3=Normal, 4=Low). Used when the channel generates a task.

Example request

{
  "status": 1,
  "taskNote": "Follow up within 24 hours if no reply",
  "payload": {
    "subject": "Following up, {{firstName}}",
    "content": "<p>Hi {{firstName}},</p><p>Wanted to follow up on my last email.</p>",
    "preheader": "Following up"
  },
  "absoluteDays": 3,
  "attachmentIds": [
    "lN5xKp2vJq",
    "aQ8dVzYw1R"
  ],
  "assigneeId": "z6R8Mw4vBn"
}

Response

Sequence step variant updated successfully

{"stackTrail":"paths:/v1/sequences/{sequenceId}/steps/{stepId}/variants/{variantId}:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Sequence step variant updated successfully","payload":1}}

Example response

{
  "message": "Sequence step variant updated successfully",
  "payload": 1
}

Changes

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