Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Close or reopen a conversation, snooze it, assign it, set its priority or labels.
conversations:write scope.| Field | Type | Required | Notes |
|---|---|---|---|
contact_id | string | Yes | The person’s contact id: it names their conversation. |
| Field | Type | Required | Notes |
|---|---|---|---|
state | string | No | open or closed. |
assignee | string | No | A team member’s email, or null for nobody. |
priority | string | No | normal, high or urgent. |
snoozed_until | string | No | An ISO time with its offset, in the future; null wakes it. |
labels | array | No | Label names that exist on the account. Replaces its labels. |
curl -X PATCH https://api.fireflo.au/v1/conversations/3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42 \
-H "Authorization: Bearer $OMNI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"assignee": "priya@acme.in",
"priority": "high",
"labels": [
"orders"
]
}'
import os
import requests
response = requests.patch(
"https://api.fireflo.au/v1/conversations/3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42",
headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
json={
"assignee": "priya@acme.in",
"priority": "high",
"labels": ["orders"],
},
)
print(response.status_code, response.json())
const response = await fetch("https://api.fireflo.au/v1/conversations/3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"assignee": "priya@acme.in",
"priority": "high",
"labels": [
"orders"
]
}),
});
console.log(response.status, await response.json());
200 OK — the conversation as it now stands.
{
"id": "3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42",
"contact": {
"id": "3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42",
"name": "Asha Rao",
"phone": "+919876543210"
},
"channels": [
"sms",
"whatsapp"
],
"state": "open",
"snoozed_until": null,
"assignee": {
"name": "Priya Nair",
"email": "priya@acme.in"
},
"priority": "high",
"labels": [
"orders"
],
"unread": 2,
"waiting_since": "2026-10-05T09:02:17.120Z",
"last_message_at": "2026-10-05T09:02:17.120Z",
"created": "2026-08-14T05:22:40.015Z"
}
{"error": {"code", "message", "field"}}; field is there when one input is at fault.
| Status | Error code | When |
|---|---|---|
| 404 | not_found | No conversation has that id on this account. |
| 400 | invalid_request | An input is wrong: an unknown state or priority, no active team member with that email, a snooze time that is bad or past, an unknown label (field names it). |
| 400 | invalid_json | The body isn’t valid JSON. |
| 403 | scope_missing | The key doesn’t have the conversations:write scope. |
key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.