Current - 2026/07
Endpoint
GET
/v1/stable/transcript-property

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json

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.

properties
object[]
required
StableTranscriptProperty — see its attributes above
Current - 2026/07
Endpoint
POST
/v1/stable/transcript-property

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

Request body

name
string
required
type
enum<string>
required

The type of value the property holds.

Available options: boolean, number, string

Response

201 - application/json

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.

property
object
required
StableTranscriptProperty — see its attributes above
Current - 2026/07
Endpoint
GET
/v1/stable/transcript-property/{propertyID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

propertyID
string
required

The ID of the transcript property to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json

Returns a single transcript property with its name, value type, owning project, and creation and update timestamps.

property
object
required
StableTranscriptProperty — see its attributes above
Endpoint
PATCH
/v1/stable/transcript-property/{propertyID}

Changes an existing transcript property in place. The response carries only a confirmation message, so refetch the transcript property to read its new values.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

propertyID
string
required

The ID of the transcript property to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

Request body

name
string

Response

200 - application/json

Confirms the property was renamed. The body is a message rather than the updated property, so refetch the property to read its new name.

message
string
required

A human-readable message confirming the update.

Current - 2026/07
Endpoint
DELETE
/v1/stable/transcript-property/{propertyID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

propertyID
string
required

The ID of the transcript property to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

Response

200 - application/json

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.

message
string
required

A human-readable message confirming the deletion.

Endpoint
PUT
/v1/stable/transcript-property/{propertyID}/value

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

propertyID
string
required

The ID of the transcript property to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

Request body

value
string
required

The value to set for the property on the transcript.

transcriptID
string
required

The ID of the transcript to set the property value on.

metadata
object

Additional structured data to record alongside the value. Omit or pass null to record none.

Response

200 - application/json

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.

message
string
required

A human-readable message confirming the update.

Schemas

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