ResponseErrorDetail

Granular error detail for a single field or condition within a failed Recommendations or Suggestions request.

Declaration

object RecommendationResponseErrorDetail

Properties

Name	Type	Description
`code`	string	A machine-readable code identifying the specific error condition. Read-only.
`message`	string	A human-readable description of the specific error. Read-only.
`info`	`RecommendationResponseErrorDetail.Info`	Additional context that supplements the message, such as the field name, the invalid value, or acceptable alternatives. Content varies by endpoint and error type. Read-only.

Discussion

The ResponseErrorDetail provides field-level granularity for errors returned in a ResponseError. Each detail entry identifies one specific condition that caused the request to fail. For example, this occurs for a missing required field, an invalid value, or a constraint violation.

The code and message fields identify the nature of the issue. When details contains multiple entries, correct all issues before retrying. The API rejects the request atomically on the first validation pass.

Example

{
  "code": "MISSING_REQUIRED_FILTER",
  "message": "Filter 'promotedObjectId' is required",
  "info": {
    "field": "promotedObjectId",
    "location": "filters"
  }
}

Topics

Dictionaries

RecommendationResponseErrorDetail.Info