propertyErrorDetailError

  • Name
    object
    Type
    string
    Description

    Type of object is always propertyErrorDetail.

    Allowed values: propertyErrorDetail 
  • Name
    code
    Type
    string
    Description

    A machine-readable description of the error.

    Example: "propertyRequired"
  • Name
    message
    Type
    string
    Description

    A human readable description of the error.

    Example: "Invalid value for property."
  • Name
    property
    Type
    string
    Description

    Name of the property associated with the error.

    Example: "property1"
  • Name
    suggestion
    Type
    nullable string
    Description

    Suggested alternative value for the field.

    Example: "alternative_value"

Example

{
  "object": "propertyErrorDetail",
  "code": "propertyRequired",
  "message": "Invalid value for property.",
  "property": "property1",
  "suggestion": "alternative_value"
}