Skip to main content
PUT
Set the sequence's structure

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Get your API key from the Reply dashboard: Settings → API Key.

Path Parameters

sequence_id
integer
required

Sequence id

Required range: x >= 1

Body

application/json

Applies a sequence structure to the sequence by id. The structure's steps become the sequence's steps.

structureId
string
required

Structure id: g-{number} for library structures, c-{number} for structures saved by users (e.g. g-3, c-128).

Minimum string length: 1
inProgressContactsMode
enum<string>

What happens to the sequence's contacts in progress, paused ones included. Required when the sequence has used steps and contacts in progress.

Available options:
restart,
moveToStep,
finish
inProgressContactsTargetStepId
integer

Required when inProgressContactsMode is moveToStep: the structureStepId of a step in stepsToAdd of GET /v3/sequences/ai-sdr/{sequence_id}/structure/migration-preview.

Example:

2

saveCurrentStructure
boolean
default:false

When true, the sequence's current steps are also saved as a personal sequence structure named as the preview's snapshotName (<sequence name> – before <yyyy-MM-dd>, at most 50 characters). The structure change completes even if saving fails.

Response

Structure applied