2xx

200

The 200 HTTP code is used when the user's request has been successful. This is our most commonly HTTP code and should be used for all successful requests, unless the request is a POST (see [201]) or there are multiple status codes being returned (though this is discouraged, see [207])

Example response

201

Used when a new resource has been created.

The body of the response should be the same as the GET representation of the new resource, including any generated/calculated fields.

Example response

202

Acknowledges the request has been received, but not that the process has been completed. Used for asynchronous tasks, such as if the action will be placed in a queue, or depends on an external service with a slow response time.

The response body should include status information and an identifier for the resource, such as a self link (some of our APIs return an ID here which is also acceptable).

Example response

204

Generally used on a successful DELETE. As the resource has been deleted there is no body.

Example response

Empty response body

207

A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate.

This should not be used unless in exceptional circumstances

Example response