Skip to main content

FieldError

Details of the request error

detailstringrequired

A human-readable explanation specific to this occurrence of the problem

fieldstringrequired

The identifier of the field that is causing the issue

instancestring | nullnullable

A URI reference that identifies the specific occurrence of the problem

Default value: null
Example: https://example.com/errors/invalid-body
codestring | nullnullable

Stable machine-readable code of the error, on the endpoints that define one (company contact cards); absent elsewhere

Example: EMAIL_ALREADY_USED
params object | null

Values of this occurrence for the code, such as the offending value

property name*string
FieldError
{
  "detail": "string",
  "field": "string",
  "instance": "https://example.com/errors/invalid-body",
  "code": "EMAIL_ALREADY_USED",
  "params": {
    "value": "jean@presta.fr"
  }
}