ApiErrorResponse
Common HTTP error envelope. errors is present for DTO validation and contains all invalid paths; it is omitted for non-field business errors. Workspace configuration validation may include safe numeric bounds and related field paths in errors[].details.
statusCodeintegerrequired
Example:
400codestringrequired
Stable machine-readable error code.
Example:
INVALID_PHONEmessagestringrequired
Example:
INVALID_PHONEhintstringrequired
Safe next action for resolving the error.
Example:
Review the request fields and retry.errors object[]
Array [
fieldstringrequired
Example:
contacts.0.phones.0.phonecodestringrequired
Example:
INVALID_PHONEdetails object
Safe validation bounds and dependencies; never contains rejected values.
minnumber
maxnumber
relatedFieldsstring[]
]
retryAfterstring
Safe wait in seconds, also returned as the Retry-After header when supplied by the provider.
Possible values: Value must match regular expression ^\d{1,8}$
alternatives object[]
Available when an appointment slot is rejected and safe alternative slots can be offered.
Array [
startstring<date-time>required
endstring<date-time>required
]
ApiErrorResponse
{
"statusCode": 400,
"code": "INVALID_PHONE",
"message": "INVALID_PHONE",
"hint": "Review the request fields and retry.",
"errors": [
{
"field": "contacts.0.phones.0.phone",
"code": "INVALID_PHONE",
"details": {
"min": 0,
"max": 0,
"relatedFields": [
"string"
]
}
}
],
"retryAfter": "string",
"alternatives": [
{
"start": "2024-07-29T15:51:28.071Z",
"end": "2024-07-29T15:51:28.071Z"
}
]
}