Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Add an internal note to a ticket — never sent to the customer.
tickets:write scope.| Field | Type | Required | Notes |
|---|---|---|---|
| ticket_id | string | Yes | The ticket’s id. |
| Field | Type | Required | Notes |
|---|---|---|---|
body | string | Yes | The note. Up to 5,000 characters. |
curl -X POST "https://api.fireflo.au/v1/tickets/b84f2c10-5e7a-4c3d-9a61-0f2d7e9c4a18/notes" \
-H "Authorization: Bearer $OMNI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"body": "Refund of ₹1,200 held until delivery is confirmed."
}'
import os
import requests
response = requests.post(
"https://api.fireflo.au/v1/tickets/b84f2c10-5e7a-4c3d-9a61-0f2d7e9c4a18/notes",
headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
json={
"body": "Refund of ₹1,200 held until delivery is confirmed."
},
)
print(response.status_code, response.json())
const response = await fetch("https://api.fireflo.au/v1/tickets/b84f2c10-5e7a-4c3d-9a61-0f2d7e9c4a18/notes", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"body": "Refund of ₹1,200 held until delivery is confirmed."
}),
});
console.log(response.status, await response.json());
201 Created — the note.
{
"id": 318,
"body": "Refund of ₹1,200 held until delivery is confirmed.",
"author": "API · Order sync",
"created_at": "2026-10-06T10:15:03+05:30"
}
{"error": {"code", "message", "field"}}; field is there when one input is at fault.
| Status | Error code | When |
|---|---|---|
| 404 | not_found | No ticket has that id on this account. |
| 400 | invalid_request | body is missing, empty, not a string or too long (field names it). |
| 400 | invalid_json | The body isn’t valid JSON. |
| 404 | module_off | The account’s plan doesn’t include Tickets. |
| 403 | scope_missing | The key doesn’t have the tickets:write scope. |
key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.