v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Sequence Steps

List step variants

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

Returns all variants for a sequence step

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

Path parameters

idinteger required

Sequence Id

step_idinteger required

Step Id

Response

List of variants retrieved 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
  }
]