Errors
The external API returns a simple JSON error object when a request fails.
Error format
{
"error": "Error message describing why the request failed."
}
Status codes
- Name
400- Description
Invalid request body or missing required input.
- Name
401- Description
Missing API key or invalid API key.
- Name
404- Description
Requested resource was not found (for example agent, category, or call).
- Name
409- Description
Conflict (for example duplicate agent or email already in use).
Common success codes:
- Name
200- Description
Successful read/update/delete response.
- Name
201- Description
Resource created (
POST /agents).
- Name
202- Description
Accepted for async processing (
POST /calls).