Update Sequence Step Variant
PATCH /v1/sequences/{sequenceId}/steps/{stepId}/variants/{variantId}
/v1/sequences/{sequenceId}/steps/{stepId}/variants/{variantId}{sequenceId}/steps/{stepId}/variants/{variantId}Update a step variant for a sequence
Update the payload, status, taskNote, priority, assigneeId, or attachmentIds of an existing variant. The payload shape must match the step's channel (see OpenAPI.md).
Authorization
x-api-key<token>
API key for Open API authentication
In: header
Request Body
application/jsonRequiredstatusnumber
Variant status: 0 = Inactive (paused), 1 = Active.
Example:1Value in: 0 | 1taskNotestring
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.
Example:"Follow up within 24 hours if no reply"Maximum length: 3000payloadobject
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: {}).
{"subject":"Following up, {{firstName}}","content":"<p>Hi {{firstName}},</p><p>Wanted to follow up on my last email.</p>","preheader":"Following up"}absoluteDaysnumber
Override day number for this variant (1–999). Each day can hold at most one Email step.
Example:3Minimum: 1attachmentIdsarray<string>
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.
["lN5xKp2vJq","aQ8dVzYw1R"]typestring
Channel type of the variant. Rarely changed on update — must still match the parent step.
Example:1Value in: "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.
Example:"z6R8Mw4vBn"prioritystring
Task priority (1=Urgent, 2=High, 3=Normal, 4=Low). Used when the channel generates a task.
Example:3Value in: "Urgent" | "High" | "Normal" | "Low"Path Parameters
sequenceIdstring
The ID of the sequence
stepIdstring
The ID of the step
variantIdstring
The ID of the variant
Responses
{
"message": "Sequence step variant updated successfully",
"payload": 1
}