Contents

ErrorDetail

Field-level or request-level detail for a specific part of a failed API request.

Declaration

object ErrorDetail

Properties

NameTypeDescription
code Requiredstring

A machine-readable code identifying the specific violation, such as FIELD_REQUIRED for a missing required field or INVALID_VALUE for a field that failed validation.

messagestring

A human-readable description of this specific violation, such as which field was missing or invalid and why.

Discussion

The ErrorDetail provides field-level or request-level granularity for a specific part of a failed request. Each entry in the Error.details array is one ErrorDetail.

Example

{
  "code": "FIELD_REQUIRED",
  "message": "campaign.name is required and was not provided for AwayFinder campaign creation."
}

See Also

Error Responses