sequence.updateStage

Beta

This endpoint is in beta and may not be available for all organizations.

Replaces the supplied subject or HTML body of one email stage in a not-started sourcing sequence. At least one of subject or body is required. The reusable sequence template is not changed.

Subject is plain text. body uses the rich-text input shape { type: "text/html", value: "<p>...</p>" }. The HTML value may preserve, move, repeat, or remove the Ashby token markers returned by sequence.info or sequence.add. Token identity and final send-time values remain controlled by Ashby; unknown or malformed token markers return invalid_input.

Drafts are editable only by the acting user who created them, so requests made with x-on-behalf-of must continue using the same user. Returns sequence_not_found for an inaccessible sequence.

Requires the sourcingWrite permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The unique identifier for the sequence enrollment

uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The unique identifier for the email stage to update

string

A plain-text subject that replaces the stage's current subject

body
object

The rich-text body that replaces the stage's current body

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json