Error Handling

Use this page to understand:

• How API errors are structured
• How to use code, message, and doc_url

Error Response Body

Field	Type	Description
errors	array	List of one or more error objects.
errors[].code	string	Stable machine-readable code for client handling.
errors[].message	string	Human-readable detail of what failed.
errors[].doc_url	string	Absolute URL to the matching error-code page (domain depends on deployed docs environment).

Recommendation

Use code TODO ...

Error Code Directory

Filter error codes

5 results

Error code	HTTP status	Description
parameter_invalid	400	One or more request parameters do not satisfy the expected schema.
resource_not_found	404	The requested resource does not exist.
conflict	409	The request could not be completed because of a state conflict.
unauthorized	401	Authentication is missing, invalid, or rejected.
internal_server_error	500	An unexpected server-side error occurred.

HTTP Status Code Reference

HTTP status	Meaning in current API behavior
200 OK	Successful cancellation response
201 Created	Resource created successfully
401 Unauthorized	Missing or invalid authentication
400 Bad Request	Request validation or client input error
404 Not Found	Referenced entity or request does not exist
409 Conflict	Operation rejected due to state conflict
500 Internal Server Error	Unexpected server error