Update a conversation
curl --request PATCH \
--url https://api.awardee.com/v1/conversations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"contact_email": "[email protected]",
"contact_name": "<string>",
"contact_phone": "<string>",
"assigned_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
contact_email: '[email protected]',
contact_name: '<string>',
contact_phone: '<string>',
assigned_to: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.awardee.com/v1/conversations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.awardee.com/v1/conversations/{id}"
payload = {
"title": "<string>",
"contact_email": "[email protected]",
"contact_name": "<string>",
"contact_phone": "<string>",
"assigned_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"object": "conversation",
"id": "8f3a9d2e-1b4c-4f5d-9e8a-7c3b2a1d0f9e",
"chatbot_id": "c1f5b2a7-9e8d-4f6a-b3c4-d5e6f7a8b9c0",
"status": "open",
"priority": "low",
"title": "Refund question",
"summary": "Visitor asked about refund window. Bot escalated to human.",
"sentiment_score": 72,
"contact_email": "[email protected]",
"contact_name": "Ada Lovelace",
"contact_phone": "+1 415 555 0143",
"assigned_to": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"last_message_preview": "<string>",
"last_message_at": "2023-11-07T05:31:56Z",
"resolved_at": "2023-11-07T05:31:56Z",
"closed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"qr_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"qr_context": {
"qr_code": {
"id": "a7149db7-fe17-4ce7-b9ed-909ec231d566",
"name": "Room 7 — TV"
},
"qr_group": {
"id": "db76aa7b-d0f2-499c-8dc2-86afbb7df37b",
"name": "Room 7"
},
"properties": {
"TV Model Number": "LG 43UQ9000PSD",
"Kettle Model Number": "Breville LKE755"
}
}
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}Endpoints
Update a conversation
Updates status, priority, contact info, assignee, or title. Status and assignee transitions automatically emit activity events and webhook notifications. status cannot be set to bot_active via the API — once a human or API caller is involved, the bot does not get to take it back. sentiment_score and summary are AI-managed and read-only via the API.
PATCH
/
conversations
/
{id}
Update a conversation
curl --request PATCH \
--url https://api.awardee.com/v1/conversations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"contact_email": "[email protected]",
"contact_name": "<string>",
"contact_phone": "<string>",
"assigned_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
contact_email: '[email protected]',
contact_name: '<string>',
contact_phone: '<string>',
assigned_to: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.awardee.com/v1/conversations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.awardee.com/v1/conversations/{id}"
payload = {
"title": "<string>",
"contact_email": "[email protected]",
"contact_name": "<string>",
"contact_phone": "<string>",
"assigned_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"object": "conversation",
"id": "8f3a9d2e-1b4c-4f5d-9e8a-7c3b2a1d0f9e",
"chatbot_id": "c1f5b2a7-9e8d-4f6a-b3c4-d5e6f7a8b9c0",
"status": "open",
"priority": "low",
"title": "Refund question",
"summary": "Visitor asked about refund window. Bot escalated to human.",
"sentiment_score": 72,
"contact_email": "[email protected]",
"contact_name": "Ada Lovelace",
"contact_phone": "+1 415 555 0143",
"assigned_to": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"last_message_preview": "<string>",
"last_message_at": "2023-11-07T05:31:56Z",
"resolved_at": "2023-11-07T05:31:56Z",
"closed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"qr_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"qr_context": {
"qr_code": {
"id": "a7149db7-fe17-4ce7-b9ed-909ec231d566",
"name": "Room 7 — TV"
},
"qr_group": {
"id": "db76aa7b-d0f2-499c-8dc2-86afbb7df37b",
"name": "Room 7"
},
"properties": {
"TV Model Number": "LG 43UQ9000PSD",
"Kettle Model Number": "Breville LKE755"
}
}
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": "<unknown>",
"retry_after": 123
}Authorizations
Send your API key as Authorization: Bearer aw_live_…. Manage keys in the dashboard under Settings → API Keys.
Path Parameters
Body
application/json
Available options:
open, agent_requested, resolved, closed, archived Available options:
low, medium, high Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Minimum string length:
1Pattern:
^\+?[0-9 ()-]+$Response
Updated conversation
Allowed value:
"conversation"Example:
"8f3a9d2e-1b4c-4f5d-9e8a-7c3b2a1d0f9e"
Example:
"c1f5b2a7-9e8d-4f6a-b3c4-d5e6f7a8b9c0"
Available options:
open, bot_active, agent_requested, resolved, closed, archived Available options:
low, medium, high Example:
"Refund question"
Example:
"Visitor asked about refund window. Bot escalated to human."
Required range:
-9007199254740991 <= x <= 9007199254740991Example:
72
Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Example:
Example:
"Ada Lovelace"
Example:
"+1 415 555 0143"
Example:
"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$The QR scan context the chatbot used for this conversation. Null when the conversation didn't start from a QR scan.
Show child attributes
Show child attributes