HTTP response status codes

Information responses

None

Successful responses

Response codeStatusSummary

200

OK

The request succeeded.

The meaning of 'success' depends on the HTTP method - PUT or POST (the resource describing the result of the action is transmitted in the message body).

201

OK

Typically returned in response to a POST request, indicating that the request has been received but not yet actioned.

This response is intended for cases where another process or server handles the request, or for batch processing.

Redirection messages

None

Client error responses

Response codeStatusSummary

401

Unauthorised

Although the HTTP standard specifies 'unauthorised', semantically this response means 'unauthenticated'. That is, the client must authenticate itself to get the requested response.

The token supplied may be incorrect/expired.

413

Payload too large

The payload exceeds the limit on this API server.

Our limit is 8MB.

Reduce the payload size by splitting the data and sending over multiple calls

422

Invalid

The payload is invalid.

  • Payload is blank

  • Payload does not match the entity type expected

Server error responses

Response codeStatusSummary

500

Internal server error

The server has encountered an error and it is unable to continue

Last updated