By area
Support
Written beside the API’s code, and read from it every hour.
| Method | Path | What it does |
|---|---|---|
| POST | /v1/support/tickets | Open a ticket, or add to one by reference |
| Field | Meaning |
|---|---|
message | Required. Up to 4,000 characters. |
subject | Optional. One line, up to 120 characters. |
contact_name, contact_phone, contact_email | Who to get back to. A nested contact object with name, phone and email works too. |
contact_company, contact_company_phone | The business the person is calling about and its main number, as they gave them (company and company_phone in the contact object). Support finds the account on the business number first. A business number that is not a 10-digit US number is left out. |
reply_by | call, text or email |
caller_id | The number the person called from, when it is not contact_phone. Anything that is not a 10-digit US number (an extension, a withheld number) is left out and the ticket still opens. |
reference | Your id: letters, digits, . _ : and -, up to 80. The same one within 7 days adds to its ticket. |
source | The system that sent it, up to 80 characters |
201 opened, 200 added to an open ticket, 409 busy (wait for Retry-After: 60), 422 a field is wrong, 502 or 503 the desk cannot take it right now.