Voiceflow bearer token
Transcript properties
Label conversations with your own data.
See Authentication for credentials and permissions.
Current - 2026/07
Returns every transcript property in the project. A transcript property is a label you define once and then set on individual conversations. The call takes no paging parameters, so one request yields the whole set.
Authentication
Query parameters
The ID of the project to operate on.
Response
Returns every transcript property defined on the project, each with its name, the type of value it holds, and whether it is built in. Built-in properties cannot be updated, deleted, or have a value set.
Current - 2026/07
Adds a transcript property to the project, a label you define once and then set on individual conversations. The response carries the ID that later calls address it by.
Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
Request body
The type of value the property holds.
boolean, number, stringResponse
Creates the property and returns it with its generated ID, the value type it holds, and the project it belongs to. The property is now defined on the project but is not yet set on any transcript.
Current - 2026/07
Returns a single transcript property by ID, with the fields that define it. A transcript property is a label you define once and then set on individual conversations.
Authentication
Voiceflow bearer token
Path parameters
The ID of the transcript property to operate on.
Query parameters
The ID of the project to operate on.
Response
Returns a single transcript property with its name, value type, owning project, and creation and update timestamps.
Changes an existing transcript property in place. The response carries only a confirmation message, so refetch the transcript property to read its new values.
Authentication
Voiceflow bearer token
Path parameters
The ID of the transcript property to operate on.
Query parameters
The ID of the project to operate on.
Request body
Response
Confirms the property was renamed. The body is a message rather than the updated property, so refetch the property to read its new name.
A human-readable message confirming the update.
Current - 2026/07
Deletes a single transcript property by ID. A transcript property is a label you define once and then set on individual conversations. The response carries only a confirmation message, so refetch the transcript properties to see what is left.
Authentication
Voiceflow bearer token
Path parameters
The ID of the transcript property to operate on.
Query parameters
The ID of the project to operate on.
Response
Confirms the transcript property was deleted. The body is a message only, so refetch the project's properties to see which ones remain available to filter on.
A human-readable message confirming the deletion.
Sets a property’s value on one conversation. Defining the property and setting it are separate calls, so the definition is reused across every transcript that carries it.
Authentication
Voiceflow bearer token
Path parameters
The ID of the transcript property to operate on.
Query parameters
The ID of the project to operate on.
Request body
The value to set for the property on the transcript.
The ID of the transcript to set the property value on.
Additional structured data to record alongside the value. Omit or pass null to record none.
Response
Confirms the value was set on the transcript named in the request body. The body is a message only, so read the transcript back to see the stored value.
A human-readable message confirming the update.
Legacy - 2025/05
Get all transcript properties for the specified project.
Authentication
Voiceflow API key
Path parameters
ID of the target Voiceflow project.
Response
Legacy - 2025/05
Get the definition of the specified transcript property.
Authentication
Voiceflow API key
Path parameters
ID of the property to target.
Response
Legacy - 2025/05
Remove the specified property from all transcripts along with their values.
Authentication
Voiceflow API key
Path parameters
ID of the property to target.
Response
Legacy - 2025/05
Create a new transcript property definition.
Authentication
Voiceflow API key
Request body
ID of the project this property belongs to.
The name of this property.
The type of value held by this property.
boolean, number, string