About Errors

Errors are a fundamental component of Wix's APIs, providing critical information and guidance when something goes wrong. Most of Wix's errors follow a standardized format, as described below.

Error properties

PropertyDescription
messageTextual description that provides a brief explanation of the error.
detailsAdditional contextual information about the error, including either applicationError or validationError. See the tables below.

Application error data

An application error occurs when the service business-logic decides to reject the request. This includes codes like UNAUTHENTICATED, PERMISSION_DENIED, NOT_FOUND, ALREADY_EXISTS, ABORTED and RESOURCE_EXHAUSTED.

PropertyDescription
codeIdentifier that categorizes and signifies the specific error.
descriptionDetailed explanation of why the error occurred.
dataAdditional contextual information related to the error.

Examples

Copy
Copy

Validation error data

A validation error occurs when input data fails to meet predefined criteria or constraints set by the system. This type of error serves to enforce rules such as correct data formats, required fields, or value ranges. This includes rules like OUT_OF_RANGE and INVALID_ARGUMENT. Multiple violations may be returned in one response.

PropertyDescription
fieldViolationsArray of validation issues found in individual fields.
fieldViolations.fieldField name.
fieldViolations.descriptionDetailed explanation of why the error occurred for the specified field.
fieldViolations.violatedRuleSpecific rule or constraint that was violated by the input in the identified field.
fieldViolations.ruleNameName of specific rule or constraint that was violated. For example, "VALIDATION_ERROR".
fieldViolations.dataAdditional contextual information related to the field violation.

Example

Copy

System errors

A system error occurs when there's an exception in the system, server is down, or some dependent service or database is down.
These errors are sent empty by design.

Example

Copy
Did this help?