Skip to main content
When a request fails, the response tells you what went wrong and where. Validation and business errors come back as a list:
Response body
  • code is stable. Build your error handling on it, never on message.
  • field is the path to the value. Positions in lists are written as [n], for example core.phone_numbers[0].phone_type. An error that is not about one value has field null.
  • params holds the values behind the error, for example the existing record’s id on a duplicate external_ref, or the edition on an If-Match mismatch. It is null when there are none.
A request can fail on several values at once. All of them are returned together. Authentication errors (401, 403) don’t use this list; see Authentication.

Status codes

Common codes

These are the codes you are most likely to see on employee calls. Codes that start with a country code, such as GB_, come from that country’s rules. The examples in the table come from the UK.