Errors and Error Codes
Upon error, a response will contain details to help resolve the error. The response will contain the following fields:
Attribute | Type | Description |
Code |
| Error code. |
Message |
| A detailed error message. We recommend not to rely on the message to programmatically handle the error. Use Code to do that instead. |
ID |
| Optional. For 500 responses only. If you encounter an error and this field is present, you can send us this ID for our reference. |
ExtraData |
| Optional. Extra data that may be helpful to handle the error. This could be a JSON string. |
InnerErrors |
| Optional. For validation errors specifically. See InnerError. |
Attribute | Type | Description |
Code |
| Error code. |
Path |
| The name of the request object's attribute that has errors. |
Message |
| A detailed error message. We recommend not to rely on the message to programmatically handle the error. Use Code to do that instead. |
