Endpoint
POST
/v1/stable/message/get-many

Reads several messages by ID in one call. An ID that matches no message in the environment is reported instead of failing the request.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

ids
string[]
required

Message IDs to read. Duplicates are ignored; at most 50 distinct IDs.

Minimum items: 1

Response

200 - application/json

Returns the messages found, each with its variants, and missing, the requested IDs that match no message in this environment.

messages
object[]
required

The messages found, in request order.

StableMessage — see its attributes above
missing
string[]
required

Requested IDs that match no message in this environment, in request order.

Endpoint
GET
/v1/stable/message/{messageID}

Returns one message with all of its variants. A message is a set of alternative texts for one slot, and the runtime says one of them.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

messageID
string
required

The ID of the message to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Returns the message with its variants, each carrying its text, delay in milliseconds, condition, timestamps, and user IDs.

message
object
required
StableMessage — see its attributes above
Endpoint
PATCH
/v1/stable/message/{messageID}

Changes the sequence of a message's variants without touching their text. The request must name every variant ID of the message exactly once.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

messageID
string
required

The ID of the message to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

variantOrder
string[]
required

Every variant ID of the message, each exactly once, in the new order.

Minimum items: 1

Response

200 - application/json

Confirms the variants were reordered. The body is a message only, so refetch the message to see the new sequence.

message
string
required

A human-readable message confirming the update.

Endpoint
DELETE
/v1/stable/message/{messageID}

Deletes a message and its variants. The call does not check which tool slot, step or reprompt holds the ID, so clear those owners first. The response carries only a confirmation message, so refetch the messages to see what is left.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

messageID
string
required

The ID of the message to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Confirms the message was deleted. The body is a message only, so any tool slot or step that held the ID still points at a message that no longer exists.

message
string
required

A human-readable message confirming the deletion.

Endpoint
POST
/v1/stable/message

Creates a message, which is a set of variants that say the same thing in different words, and returns it with its ID. The message belongs to nothing until a tool slot, workflow step, or reprompt holds its ID.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

variants
object[]
required

The variants, in stored order. They are alternatives: the runtime says one of them each time. The first variant cannot carry a condition.

Minimum items: 1
StableMessageVariantCreateRequest — see its attributes above

Response

201 - application/json

Returns the new message with its variants and IDs, and unresolvedReferences for any variable or reference in the text that did not resolve.

message
object
required
StableMessage — see its attributes above
unresolvedReferences
object[]

References this write kept as literal text instead of binding, each with the reason. The write still succeeded.

StableUnresolvedReference — see its attributes above
Endpoint
POST
/v1/stable/message/batch

Creates several messages in one call, each with its own variants. None of them belongs to anything until a tool slot, workflow step, or reprompt holds its ID.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

messages
object[]
required

The messages to create, at most 50. Each entry is the body of a single create. The response lists them in this order.

Minimum items: 1 · Maximum items: 50
StableMessageCreateRequest — see its attributes above

Response

201 - application/json

Returns the new messages, in request order, with their variants and IDs, and unresolvedReferences for any variable or reference in the text that did not resolve.

messages
object[]
required

The created messages, in request order.

StableMessage — see its attributes above
unresolvedReferences
object[]

References this write kept as literal text instead of binding, each with the reason. The write still succeeded.

StableUnresolvedReference — see its attributes above
Endpoint
POST
/v1/stable/message/{messageID}/variant

Adds another alternative text to an existing message, placed after the variants it already has. The runtime says one variant of a message, not all of them in turn.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

messageID
string
required

The ID of the message to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

text
object
required

Message text shown to the end user. Limited markdown: bold, _italic_, <u>underline</u>, ~~strikethrough~~, [label](url). {variable_name} inserts a variable or entity, {variable_name.path} a field of a variable. Escape a literal { or \ with a backslash. A name matching neither is stored as literal text and reported in unresolvedReferences; secrets are not available here.

MarkdownLikeString — see its attributes above
delay
integer

Milliseconds to wait before this variant is sent.

Minimum: 0 · Maximum: 2147483647
condition
object

Response

201 - application/json

Returns the new variant with its ID, and unresolvedReferences for any variable or reference in its text that did not resolve.

variant
object
required
StableMessageVariant — see its attributes above
unresolvedReferences
object[]

References this write kept as literal text instead of binding, each with the reason. The write still succeeded.

StableUnresolvedReference — see its attributes above
Endpoint
PATCH
/v1/stable/message/{messageID}/variant/{variantID}

Edits one variant of a message in place, so the message keeps its ID and its owner. Send only the text, delay, or condition you want to change; condition: null removes the condition.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

messageID
string
required

The ID of the message to operate on.

variantID
string
required

The ID of the message variant to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

text
object
delay
integer

Milliseconds to wait before this variant is sent. null removes the delay.

Minimum: 0 · Maximum: 2147483647
condition
object

Response

200 - application/json

Confirms the variant was updated. The body is a message, with unresolvedReferences for any variable or reference in the new text that did not resolve.

message
string
required

A human-readable message confirming the update.

unresolvedReferences
object[]

References this write kept as literal text instead of binding, each with the reason. The write still succeeded.

StableUnresolvedReference — see its attributes above
Endpoint
DELETE
/v1/stable/message/{messageID}/variant/{variantID}

Removes one variant from a message; a message needs at least one, so delete the message to drop the last. The response is a confirmation message, so refetch the message to see its variants.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

messageID
string
required

The ID of the message to operate on.

variantID
string
required

The ID of the message variant to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Confirms the variant was deleted. The body is a message that also says when deleting the first variant cleared the condition of the one that took its place.

message
string
required

A human-readable message confirming the deletion.

Schemas

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.