Error codes

When an error occurs, an error code and path are returned. The code parameter returns a code that explains why the error occurred.

The path parameter contains the submitted fields and subfields that are relevant to the error. The path parameter always starts with the #/ value. For example, when a site ID within a request is incorrect, #/siteID is returned. When only #/ is returned, the entire document or more than one parameter contains errors.

The error codes are as follows:

Error code

Description

ARRAY_LENGTH_LONG

The specified array is too long.

ARRAY_LENGTH_SHORT

The submitted array is too short.

ARRAY_UNIQUE

The specified array contains duplicates and duplicates are not accepted.

CONFLICT_DATA

The specified data conflicts with data that is already in the system. The path parameter indicates the field containing the conflicting data.

CONFLICT_REQUEST

One or more submitted values conflict with other information in your request.

DUPLICATE_ENTITY

One or more submitted values is a duplicate and duplicates are not accepted.

ENTITY_CONFIG_INCORRECT

An entity that was directly or indirectly referenced in the request has a configuration that conflicts with the request. For example, a request to update proxy publisher settings does not succeed because the included user ID does not belong to a proxy publisher.

ENTITY_NOT_FOUND

The specified entity does not exist in the system. The entity may have been deleted, for example. The path parameter indicates the field containing the entity that does not exist.

ENTITY_NOT_PERMITTED

The request was not successful because permissions to access or update the specified entity do not exist.

ENTITY_STATUS_INCORRECT

The specified entity or one of the specified entities has a status that conflicts with your request.

INTERNAL_ERROR

An internal error occurred during validation.

INVALID_TYPE

The specified entity or one of the specified entities has the incorrect data type. For example, a string was submitted although integer is the only accepted data type.

INVALID_VALUE

One or more of the submitted values is not valid.

MAX_LENGTH

The specified string contains too many characters.

MAXIMUM

The specified number is higher than the maximum value.

MIN_LENGTH

The specified string does not contain enough characters.

MINIMUM

The specified number is lower than the minimum value.

OBJECT_ADDITIONAL_PROPERTIES

The specified data contains additional properties that should not be included in the request.

OBJECT_MISSING_REQUIRED_PROPERTY

The request does not include a required parameter. The path indicates the required parameter.

TOO_MANY_ENTITIES

The entity or entities could not be added because the database has reached its maximum amount.