ErrorResponse

A single problem with a request. Errors arrive as an array under errorResponse.errors.

  • affectedEntityIds
    Type: array integer[] | null Format: int32

    Identifiers of the entities this error relates to, where the error is about specific records rather than a field. Omitted when not applicable.

  • errorCode
    Type: string | null

    Stable machine-readable identifier for the error. This is the value to branch on. null for framework-level field validation, where errorField and errorMessage carry the detail instead.

  • errorField
    Type: string | null

    Which input caused the problem. null when the error is not tied to one field. For nested request objects this is a path, for example UserDetails.City.

  • errorMessage
    Type: string | null

    Human-readable description of what went wrong. Safe to log. Wording can change between releases, so branch on errorCode rather than on this string.

  • errorNumber
    Type: integer | null Format: int32
    read-only

    Numeric form of errorCode, and equally stable. null when errorCode is null or is not one of the catalogued codes. See the Errors and Rate Limits guide for the full list.

  • suggestions
    Type: array object[] | null · ErrorSuggestion[]

    What to do about this error, when Chaiz can suggest something concrete. Omitted entirely when there is no suggestion, so treat it as optional. Designed to be actionable without interpretation, which makes it useful for AI agents and automated integrations.

    A concrete next step for resolving an error.

    • action
      Type: string · ErrorSuggestionActionenum

      Possible values: RetryWithAlternative (0) - RetryWithAlternative, CheckInput (1) - CheckInput, ContactSupport (2) - ContactSupport, UseDifferentEndpoint (3) - UseDifferentEndpoint

      values
      • RetryWithAlternative
      • CheckInput
      • ContactSupport
      • UseDifferentEndpoint
    • endpoint
      Type: string | null

      The endpoint to call instead. Present only for RetryWithAlternative and UseDifferentEndpoint, and omitted otherwise.

    • message
      Type: string | null

      Written to be shown to an end user as-is, without rewording.