ErrorDetail

A single problem with the request, pointing at the parameter or body field responsible.

  • code
    Type: string enum
    required

    Machine-readable reason this field was rejected:

    • blank — a required value was empty or missing.
    • invalid_value — the value was the wrong shape, or outside the allowed set.
    • not_accessible — the value names a record that does not exist in your account, or that this token may not use.
    • parameter_missing — a required top-level wrapper was absent from the body.
    • unknown_filter — no such filter[...] key on this endpoint.
    • conflicting_filters — two filters were supplied that cannot be combined.
    • unknown_sort_field — no such sortable field on this endpoint.
    • internal_error — the failure could not be attributed to the request.
    values
    • blank
    • invalid_value
    • not_accessible
    • parameter_missing
    • unknown_filter
    • conflicting_filters
    • unknown_sort_field
    • internal_error
  • message
    Type: string
    required

    Human-readable description of this specific problem.

  • source
    required

    What the problem is about. Body problems carry a JSON pointer; query-string problems carry a parameter name. Exactly one of the two is present.

    What the problem is about. Body problems carry a JSON pointer; query-string problems carry a parameter name. Exactly one of the two is present.

    • pointer
      Type: string
      required

      JSON pointer to the offending field in the request body.