v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Sequence Steps

Bulk create step variants

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

Creates multiple text variants for a sequence step at once. For email steps, each variant may carry up to 3 attachmentIds (upload first via POST /v3/attachments); inaccessible attachment IDs surface as a per-item forbidden result.

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

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

Array of per-item results, one per input variant (same order as request).

Possible per-item error codes:

Error code	Meaning
invalidInput	Validation failed (e.g. more than 3 attachments)
invalidStep	Step type does not support this variant
forbidden	One or more attachment IDs are not accessible to the caller
internalError	Unexpected server error

idinteger nullable

ID of the created resource, null if creation failed

errorinteger nullable

Error code if creation failed

errorDetailsstring nullable

Human-readable error description if creation failed