Error Documents

An Error document is returned when the API encounters an error.

If the batch call itself is correct but records in the batch return an error, the call itself reads as 200 OK. The error codes appear for the relevant records in the batch. Note that error documents are not returned if the call is successful and there are no errors associated with records.

Example

Each error will include an error code, a more descriptive message, and a requestID.

{
  "error": {
    "message": "The service received an invalid zipCode: 94107f",
    "code": "600-0043",
    "requestId": "123456789987654321"
  }
}

Opted-out Users

Note that opted-out representations will be omitted from group document responses.

If a record is associated with an opted-out user, the response is error code 600-0117 with message Opted-out entity:

 {
		"code": 404,
		"document": {
			"error": {
            "message": "Opted-out entity",
            "code": "600-0117",
            "requestId": "123456789987654321"
             }
        }
	}

Error Code References

The application-level error code is comprised of a 3 digit application prefix and a 4 digit application error code.

Gateway error codes are prefaced with '000-'.

📘

Cloudflare Error Codes

All client requests are routed through Cloudflare for additional security. This means you might receive an error code from Cloudflare itself in some scenarios, such as when calls are made from an IP address that is not allowlisted. These error codes are described here: https://support.cloudflare.com/hc/en-us/sections/200820298-Cloudflare-Errors.