Voiceflow bearer token
Messages
Manage the messages your agent sends.
See Authentication for credentials and permissions.
Reads several messages by ID in one call. An ID that matches no message in the environment is reported instead of failing the request.
Authentication
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
Message IDs to read. Duplicates are ignored; at most 50 distinct IDs.
Response
Returns the messages found, each with its variants, and missing, the requested IDs that match no message in this environment.
Requested IDs that match no message in this environment, in request order.
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.
Authentication
Voiceflow bearer token
Path parameters
The ID of the message to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
Returns the message with its variants, each carrying its text, delay in milliseconds, condition, timestamps, and user IDs.
Changes the sequence of a message's variants without touching their text. The request must name every variant ID of the message exactly once.
Authentication
Voiceflow bearer token
Path parameters
The ID of the message to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
Every variant ID of the message, each exactly once, in the new order.
Response
Confirms the variants were reordered. The body is a message only, so refetch the message to see the new sequence.
A human-readable message confirming the update.
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.
Authentication
Voiceflow bearer token
Path parameters
The ID of the message to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
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.
A human-readable message confirming the deletion.
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.
Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The variants, in stored order. They are alternatives: the runtime says one of them each time. The first variant cannot carry a condition.
Response
Returns the new message with its variants and IDs, and unresolvedReferences for any variable or reference in the text that did not resolve.
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
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.
Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The messages to create, at most 50. Each entry is the body of a single create. The response lists them in this order.
Response
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.
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
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.
Authentication
Voiceflow bearer token
Path parameters
The ID of the message to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
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.
Milliseconds to wait before this variant is sent.
Response
Returns the new variant with its ID, and unresolvedReferences for any variable or reference in its text that did not resolve.
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
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.
Authentication
Voiceflow bearer token
Path parameters
The ID of the message to operate on.
The ID of the message variant to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
Milliseconds to wait before this variant is sent. null removes the delay.
Response
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.
A human-readable message confirming the update.
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
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.
Authentication
Voiceflow bearer token
Path parameters
The ID of the message to operate on.
The ID of the message variant to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
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.
A human-readable message confirming the deletion.