118 lines
2.9 KiB
YAML
118 lines
2.9 KiB
YAML
parameters:
|
|
- $ref: '#/components/parameters/account_id'
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: number
|
|
description: ID of the contact
|
|
|
|
get:
|
|
tags:
|
|
- Contact Labels
|
|
operationId: list-all-labels-of-a-contact
|
|
summary: List Labels
|
|
description: Lists all the labels of a contact
|
|
security:
|
|
- userApiKey: []
|
|
x-codeSamples:
|
|
- lang: python
|
|
label: "List contact labels"
|
|
source: |
|
|
from chatwoot import ChatwootClient
|
|
|
|
client = ChatwootClient(
|
|
base_url="https://app.chatwoot.com",
|
|
api_token="your-api-token"
|
|
)
|
|
|
|
labels = client.contacts.labels.list(
|
|
account_id=1,
|
|
contact_id=100
|
|
)
|
|
|
|
print(labels)
|
|
# ['vip', 'enterprise']
|
|
responses:
|
|
'200':
|
|
description: Success
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/contact_labels'
|
|
'401':
|
|
description: Unauthorized
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/bad_request_error'
|
|
'404':
|
|
description: Contact not found
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/bad_request_error'
|
|
|
|
post:
|
|
tags:
|
|
- Contact Labels
|
|
operationId: contact-add-labels
|
|
summary: Add Labels
|
|
description: Add labels to a contact. Note that this API would overwrite the existing list of labels associated to the conversation.
|
|
security:
|
|
- userApiKey: []
|
|
x-codeSamples:
|
|
- lang: python
|
|
label: "Add labels to contact"
|
|
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.contacts.labels.add(
|
|
account_id=1,
|
|
contact_id=100,
|
|
labels=["vip", "enterprise"]
|
|
)
|
|
|
|
print(labels)
|
|
# ['vip', 'enterprise']
|
|
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/contact_labels'
|
|
'401':
|
|
description: Unauthorized
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/bad_request_error'
|
|
'404':
|
|
description: Contact not found
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/bad_request_error'
|