Skip to main content
PATCH
/
v2
/
conversations
/
{conversation_id}
cURL
curl --request PATCH \
  --url https://api.orq.ai/v2/conversations/{conversation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "Renamed Conversation"
}
'
{
  "kind": "conversation",
  "displayName": "<string>",
  "createdAt": 123,
  "updatedAt": 123,
  "_id": "conv_01kbmyap3vzc6mtbwbdqtegan2",
  "createdById": "<string>",
  "updatedById": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
conversation_id
string
required

The unique identifier of the conversation to update The unique identifier of the conversation to update

Example:

"conv_01jj1hdhn79xas7a01wb3hysdb"

Body

application/json
​
displayName
string

Updated display name for the conversation.

Required string length: 1 - 100
Example:

"Renamed Conversation"

Response

Conversation successfully updated. Returns the complete updated conversation object.

​
kind
enum<string>
required

Type discriminator indicating this is a conversation Type discriminator indicating this is a conversation

Available options:
conversation
​
displayName
string
required

Display name for the conversation. Can be auto-generated or set by the user. Display name for the conversation. Can be auto-generated or set by the user.

Required string length: 1 - 100
​
createdAt
number
required

Unix timestamp (in milliseconds) when the conversation was created Unix timestamp (in milliseconds) when the conversation was created

​
updatedAt
number
required

Unix timestamp (in milliseconds) when the conversation was last updated Unix timestamp (in milliseconds) when the conversation was last updated

​
_id
string
default:conv_01kbmyap3vzc6mtbwbdqtegan2

Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the conversation, prefixed with "conv_" Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the conversation, prefixed with "conv_"

​
createdById
string

Optional identifier of the user or agent that created the conversation Optional identifier of the user or agent that created the conversation

​
updatedById
string

Optional identifier of the user or agent that last updated the conversation Optional identifier of the user or agent that last updated the conversation