Errors

If something goes wrong with an API request, the OneCal Unified API will return a 4xx or 5xx status code, and an error shape that looks like the following:

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

The error field will be the name of the error. It is intended to be machine readable. The message field will be a human-readable message describing the error. The requestId field will be a unique identifier for the request. Provide this to support if you need to contact support.

Status codes

Here is a list of the different categories of status codes returned by the OneCal API. Use these to understand if a request was successful.