62 lines
1.5 KiB
YAML
62 lines
1.5 KiB
YAML
tags:
|
|
- Conversations
|
|
operationId: conversation-add-labels
|
|
summary: Add Labels
|
|
security:
|
|
- userApiKey: []
|
|
description: Add labels to a conversation. Note that this API would overwrite the existing list of labels associated to the conversation.
|
|
x-codeSamples:
|
|
- lang: python
|
|
label: "Add labels to conversation"
|
|
source: |
|
|
from chatwoot import ChatwootClient
|
|
|
|
client = ChatwootClient(
|
|
base_url="https://app.chatwoot.com",
|
|
api_token="your-api-token"
|
|
)
|
|
|
|
# Note: this overwrites existing labels
|
|
labels = client.conversations.labels.add(
|
|
account_id=1,
|
|
conversation_id=42,
|
|
labels=["support", "billing"]
|
|
)
|
|
|
|
print(labels)
|
|
# ['support', 'billing']
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
required:
|
|
- labels
|
|
properties:
|
|
labels:
|
|
type: array
|
|
description: Array of labels (comma-separated strings)
|
|
items:
|
|
type: string
|
|
example: ['support', 'billing']
|
|
responses:
|
|
'200':
|
|
description: Success
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/conversation_labels'
|
|
'404':
|
|
description: Conversation not found
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/bad_request_error'
|
|
'401':
|
|
description: Unauthorized
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/bad_request_error'
|