Skip to main content

Errorresponse

Represents an error response containing a list of error details.

errors object[]

A list of errors that occurred during the request.

  • Array [
  • errorCodeint32

    Domain-specific numeric error code that uniquely identifies this failure across all modules. Use this together with errorReason to programmatically branch on failure type.

    Example: 10002
    errorReasonstring

    For more information on your error message, refer to API Response and Error Codes

    Example: INVALID_PARAMETERS
    errorSourcestring

    JSON pointer, field name, or rule identifier that locates the cause of the error in the request, so clients can highlight the offending input back to end users.

    Example: filterCriteria[0].field
  • ]
  • Errorresponse
    {
    "errors": [
    {
    "errorCode": 1,
    "errorReason": "INVALID_PARAMETERS",
    "errorSource": "filterCriteria[0].field"
    }
    ]
    }