Response
Upon successful request, the response includes data and 200 OK (GET)
, 201 CREATED (POST)
, 200 OK (PATCH)
, or 204 NO CONTENT (DELETE)
as the HTTP code. If the request fails, the response is one of the following error codes:
Response | What triggers the response? |
---|---|
400 (Bad Request) | If the request is not sent in valid JSON. Specify a Content-Type: application/json header in your request. If you sent valid JSON, the error may also mean specific fields that were invalid. |
401 (Unauthorized) | If your API token was missing or included in the body rather than the header. |
403 (Forbidden) | If you provided an API token but it was invalid or revoked, or if you don't have read/write access to the entity you're trying to view/edit. |
404 (Not Found) | If the id used in the request was inaccurate or you don't have permission to view/edit it. |
429 (Too Many Requests) | If you hit a rate limit for the API. If you receive this response, we recommend waiting at least 60 seconds before re-attempting the request. |
503 (Service Unavailable) | If the API is overloaded or down for maintenance. If you receive this response, we recommend waiting at least 60 seconds before re-attempting the request. |