API reference
Errors
Every error has one shape: error_key, message, status and, for invalid input, per-field fields (see the Errors guide). These are the ones every endpoint can return; each endpoint lists its own.
| Status | Codes | Meaning |
|---|---|---|
| 400 | captcha_failedcaptcha_requiredinvalid_input | Bad request: the input is invalid. |
| 401 | impersonation_endedunauthorized | Unauthorized: the API key is missing or invalid. |
| 402 | api_request_limit_exceededfeature_not_available | Payment required: the plan's limit is reached or the feature isn't on it. |
| 403 | email_not_verifiedforbiddenimpersonation_forbiddenorg_suspended | Forbidden: the key can't access this resource. |
| 408 | request_timeout | Request timeout. |
| 413 | content_too_large | Content too large. |
| 415 | unsupported_media_type | Unsupported media type. |
| 422 | unprocessable_entity | Unprocessable: the input is valid but can't be applied. |
| 429 | too_many_requests | Too many requests: slow down and retry later. |
| 500 | captcha_unavailableinternal_server_error | Internal server error. |
| 502 | bad_gateway | Bad gateway. |
| 503 | service_unavailable | Service unavailable. |
| 504 | gateway_timeout | Gateway timeout. |