The API will return an Error List for a failed request, which will contain one or more Error objects.

Error List Attributes

Each error has the following attributes

FieldDescription
statusThe status is false
codeGeneral context about the error. See Error Codes.
error_messagesAn array of one or more error objects.
Error List Object
{
  "status": "error.list",
  "errors": [
    {
      "code": "not_found",
      "message": "No such user_id[494817923]",
      "field": "user_id"
    },
    {
      "code": "not_found",
      "message": "No such email[[email protected]]",
      "field": "email"
    }
  ]
}

Error Object Attributes

Each Error Object has the following attributes

FieldDescription
baseHuman readable description of the error