v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Sequence Steps

Create a step variant

<small>Requires the sequences:write scope (or a broader one that includes it).</small>

Creates a new variant for a sequence step. Supports both text variants (application/json) and voice message variants (multipart/form-data).

For email-step text variants, the request may carry up to 3 attachmentIds (upload first via POST /v3/attachments). Inaccessible attachment IDs are rejected with 403 sequenceStep.forbidden.

post/v3/sequences/{id}/steps/{step_id}/variants

Path parameters

idinteger required

Sequence Id

step_idinteger required

Step Id

Request body

subjectstring nullable

Subject line of the variant

messagestring required

Message content of the variant

isEnabledboolean

Whether the variant is enabled

attachmentIdsinteger[] nullable

IDs of previously uploaded attachments to attach to this variant. Upload files via POST /v3/attachments first to obtain attachment IDs. A variant may carry up to 3 attachments. Omit or pass null to leave attachments unchanged on update; pass an empty array to clear existing attachments.

Example request

{
  "subject": "Follow up on our conversation",
  "message": "Hi {{firstName}}, I wanted to follow up...",
  "isEnabled": true,
  "attachmentIds": [
    101,
    102
  ]
}

Response

Variant created successfully

idinteger

Unique identifier for the variant

subjectstring nullable

Subject line of the variant

messagestring nullable

Message content of the variant

isEnabledboolean

Whether the variant is enabled

hasAttachmentsboolean

Whether the variant has any attachments. To retrieve or modify attachments, use GET /v3/attachments and the attachmentIds field on create/update.

Example response

{
  "id": 1,
  "subject": "Follow up on our conversation",
  "message": "Hi {{firstName}}, I wanted to follow up...",
  "isEnabled": true,
  "hasAttachments": false
}