Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Sequence

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 bodyHtml is required. The reusable sequence template is not changed.

Subject is plain text. bodyHtml 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.

post/sequence.updateStage

Request body

sequenceIdstring uuid required

The unique identifier for the sequence enrollment

stageIdstring uuid required

The unique identifier for the email stage to update

subjectstring

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

bodyHtmlstring

HTML that replaces the stage's current body. Preserve Ashby token markers to keep their send-time values dynamic.

Response

Responses from the sequence.updateStage endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "cc506f71-e2a3-438e-9130-a90b5f350ce3",
    "type": "Email",
    "from": {
      "email": "gob@example.com",
      "displayName": "Gob Bluth"
    },
    "subject": "A personalized subject",
    "bodyHtml": "<p>Would you like to talk?</p>",
    "sendAfter": {
      "kind": "NoDelay"
    }
  }
}