When an error occurs in the processing of an API request, an error message is returned. The following table lists the attributes in the JSON payload of an error message.
| Attribute | Data type | Description |
|---|---|---|
errorCode |
String | A string that uniquely identifies the type of error that occurred. Useful for programmatic handling of specific error conditions. |
message |
String | A short description of the error that occurred. |
details |
String | A detailed description of the error. |
recommendedActions |
Array<String> | A list of strings indicating suggested user actions or resolutions for the specific error condition. |
nestedErrors |
Array<ErrorMessage> | For multi-part errors (for example, form-validation errors), this field may contain specific of the individual components of the error (for example, individual fields in error). |
errorSource |
String | For multi-part errors (for example, form validation errors), this field contains the identifier of the sub-component in error (for example, the individual field name). |
data |
Object | Internal/additional data associated with the error. External clients will usually ignore this field. |