ErrorResponse

  • details
    Type: array object[]
    required

    Additional details about the error

    • message
      Type: string
      required

      Message describing how to resolve the error

    • reason_code
      Type: string
      required

      Provides an error code-specific reason for the error.

    • target
      Type: string
      required

      Specifies the part of the request that is responsible for the error

    • target_type
      Type: string enum
      required

      Specifies which part of the request the target is referring to

      values
      • HTTP_REQUEST_PATH
      • HTTP_REQUEST_BODY
      • HTTP_REQUEST_QUERY_STRING
      • HTTP_REQUEST_HEADER
  • error_code
    Type: string enum
    required

    A code that identifies the kind of error that occurred

    values
    • COULD_NOT_AUTHENTICATE
    • HTTP_BODY_IS_UNEXPECTED
    • HTTP_METHOD_NOT_ALLOWED
    • INVALID_HEADERS
    • INVALID_PARAMS
  • error_message
    Type: string
    required

    Human-readable description of the error