Update Transcript

patch https://api.voiceflow.com/v2/transcripts/{projectID}/{transcriptID}

update a transcipt record for the given projectID/transcriptID

Response

Response body

object

projectID

string

the project ID that the transcript belongs to

sessionID

string

The ID of the conversation session to record as a transcript. This should be the same value as the userID property of the Dialog API.

browser

string

the browser that was used when for the interaction

device

string

the device that was used when for the interaction

string

the operating system that was used when for the interaction

reportTags

array of strings

the tags associated with the transcript

reportTags

unread

boolean

true if the transcrip is unread, false otherwise

annotations

object

the transcript ID

_id

object

creatorID

string

the ID of the user who created the transcript

createdAt

string

the date time the transcript was created

updatedAt

string

the date time the transcript was updated

user

object

name

string

the name of the user who created the transcript

image

string

the voiceflow image of the user who created the transcript

customProperties

object

custom properties associated with the transcript

Has additional fields

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.voiceflow.com/v2/transcripts/projectID/transcriptID \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
25
 
1
{
2
  "projectID": "string",
3
  "sessionID": "string",
4
  "browser": "chrome, safari",
5
  "device": "desktop, mobile",
6
  "os": "macos, windows, linux",
7
  "reportTags": [
8
    "string"
9
  ],
10
  "unread": true,
11
  "annotations": {
12
    "_id": {
13
      "utteranceAddedCount": 0,
14
      "utteranceAddedTo": "string"
15
    }
16
  },
17
  "creatorID": "string",
18
  "createdAt": "string",
19
  "updatedAt": "string",
20
  "user": {
21
    "name": "John Doe",
22
    "image": "https://creator.voiceflow.com/assets/vf-logo-f0e2d8a2.png"
23
  },
24
  "customProperties": {}
25
}

200OK