Error Handling
OverviewThis section explains how the API reports errors and provides guidance for identifying, troubleshooting, and resolving issues. Error responses include details such as the error type, affected field (when applicable), and descriptive messages to help developers diagnose problems and implement appropriate error-handling logic
errors array object details
| Field | Description | Optional field/Nullable? | Type | Possible values |
|---|---|---|---|---|
| field | JSON field associated with the error (for example, startDate ). Omitted if the error applies to the request as a whole. | Y | string | |
| errorType | Machine-readable error code that uniquely identifies the error condition. Applications should use this value for error handling logic. | N | string | |
| description | Human-readable explanation of the error, including why the request failed and, when possible, how to resolve it | N | string |
Updated about 4 hours ago
Did this page help you?