Response Codes
200- OK: Request succeeded201- Created: Resource was successfully created400- Bad Request: Invalid request parameters or validation failed401- Unauthorized: Missing or invalid authentication403- Forbidden: Authenticated but insufficient permissions404- Not Found: Requested resource doesn’t exist429- Too Many Requests: Rate limit exceeded500- Internal Server Error: Something went wrong on our end
Error Response Format
When an error occurs, the API returns a JSON response with error details:Error message
Detailed error description
HTTP status code
Error code
Additional error details
Example Error Response
error field provides a concise message, while the message field offers a more detailed explanation. The status code is 400, and the code is INVALID_REQUEST.
For more detailed information, you can refer to the details object, which includes the name of the field that caused the error.
This format helps you quickly identify and resolve issues in your API requests.