chore: Add Swagger endpoint for updating custom attributes (#10995)

- Add swagger endpoint for updating custom attributes in a conversation
This commit is contained in:
Sojan Jose
2025-02-27 16:57:25 -08:00
committed by GitHub
parent 80c87da8c9
commit a8febc00d3
4 changed files with 117 additions and 0 deletions

1
.gitignore vendored
View File

@@ -73,6 +73,7 @@ test/cypress/videos/*
#ignore files under .vscode directory #ignore files under .vscode directory
.vscode .vscode
.cursor
# yalc for local testing # yalc for local testing
.yalc .yalc

View File

@@ -0,0 +1,36 @@
tags:
- Conversations
operationId: update-custom-attributes-of-a-conversation
summary: Update Custom Attributes
description: Updates the custom attributes of a conversation
security:
- userApiKey: []
- agentBotApiKey: []
parameters:
- name: data
in: body
required: true
schema:
type: object
required:
- custom_attributes
properties:
custom_attributes:
type: object
description: The custom attributes to be set for the conversation
example:
order_id: "12345"
previous_conversation: "67890"
responses:
200:
description: Success
schema:
type: object
properties:
custom_attributes:
type: object
description: The custom attributes of the conversation
404:
description: Conversation not found
401:
description: Unauthorized

View File

@@ -354,6 +354,13 @@
post: post:
$ref: ./application/conversation/toggle_priority.yml $ref: ./application/conversation/toggle_priority.yml
/api/v1/accounts/{account_id}/conversations/{conversation_id}/custom_attributes:
parameters:
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/conversation_id'
post:
$ref: ./application/conversation/custom_attributes.yml
# Conversations Assignments # Conversations Assignments
/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments: /api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments:

View File

@@ -3514,6 +3514,79 @@
} }
} }
}, },
"/api/v1/accounts/{account_id}/conversations/{conversation_id}/custom_attributes": {
"parameters": [
{
"$ref": "#/parameters/account_id"
},
{
"$ref": "#/parameters/conversation_id"
}
],
"post": {
"tags": [
"Conversations"
],
"operationId": "update-custom-attributes-of-a-conversation",
"summary": "Update Custom Attributes",
"description": "Updates the custom attributes of a conversation",
"security": [
{
"userApiKey": [
]
},
{
"agentBotApiKey": [
]
}
],
"parameters": [
{
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"required": [
"custom_attributes"
],
"properties": {
"custom_attributes": {
"type": "object",
"description": "The custom attributes to be set for the conversation",
"example": {
"order_id": "12345",
"previous_conversation": "67890"
}
}
}
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "object",
"properties": {
"custom_attributes": {
"type": "object",
"description": "The custom attributes of the conversation"
}
}
}
},
"404": {
"description": "Conversation not found"
},
"401": {
"description": "Unauthorized"
}
}
}
},
"/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments": { "/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments": {
"parameters": [ "parameters": [
{ {