Skip to main content

PUT Conversations


This API updates an existing Conversation object with any metadata you would like to maintain.

API Request#

PUT https://api.symbl.ai/v1/conversations/{conversationId}

Example API Call#

info

Before using the Conversation API, you must get the authentication token (AUTH_TOKEN) from our authentication process.

curl "https://api.symbl.ai/v1/conversations/{conversationId}" \
-H "Authorization: Bearer $AUTH_TOKEN"
note

The following fields cannot be updated/deleted:

  • id

  • type

Request Body#

Given below is an example of the request along with optional query parameters. For a complete list of query parameters and their description, see the table below.

{
"type": "meeting",
"name": "My Test Meeting",
"startTime": "2021-02-24T15:53:05.594Z",
"endTime": "2021-02-24T16:18:05.048Z",
"members": [
{
"name": "John",
"email": "john@example.com"
},
{
"name": "Mary",
"email": "mary@example.com"
}
],
"metadata": {
"key": "value",
"agentId": "johndoe"
}
}

Response#

The updated Conversation object is returned in the response body.

{
"id": "4931769134481408",
"type": "meeting",
"name": "My Test Meeting",
"startTime": "2021-02-24T15:53:05.594Z",
"endTime": "2021-02-24T16:18:05.048Z",
"members": [
{
"name": "John",
"email": "john@example.com"
},
{
"name": "Mary",
"email": "mary@example.com"
}
],
"metadata": {
"key": "value",
"agentId": "johndoe"
}
}

Response Object#

FieldDescription
idThe unique conversation identifier. This field cannot be updated.
typeThe conversation type. Default value is meeting. This field cannot be updated.
nameThe name of the conversation.
startTimeDateTime value of when the conversation started.
endTimeDateTime value of when the conversation ended.
membersA list of member objects containing ID, name and email (if detected).