Get booking intake settings

Get required/optional booking fields, document-type codes and active payers. Pass payerQuery when a document already identifies the payer (e.g. the health plan on an insurance card), to omit unrelated payers. Reuse clear patient data from the conversation or documents instead of asking it again; request only missing required or ambiguous values. Each payer includes attended sites and sitesNote: a nonempty sites list restricts which IPS/sede is served; an empty list means all its sites. Each payer also has bookingPolicy: 'staff_only' means only the clinic's team books its patients, so never book them; use add_to_waitlist with reason payer_review instead. An empty payer match does not establish coverage.

Scopes: any one of agenda:bookings:read, agenda:bookings:write
Credentials: an API key, a client-credentials token or a person's access token
Effect: read-only; safe to retry
Limits: response up to 8 MB
CLI: arbol agenda booking-requirements get · MCP tool: agenda_booking_requirements_get

GET

https://api.getarbol.com/v1/agenda/booking-requirements

Authorization

Authorization
string
required
Bearer <token>, where the token is an API key, a client-credentials token or a person's access token with any one of the scopes agenda:bookings:read, agenda:bookings:write. Get an API key.

Query parameters

payerQuery
optional
string
Known payer name to narrow the active payer list; an empty match never establishes coverage.
channel
optional
voice
or
whatsapp
or
web
The conversation's channel, set by the platform. It changes nothing in Agenda; omit it.
connectionId
optional
string
The platform's id for the organization's Agenda, set by the platform. An organization has one Agenda, so it selects nothing; omit it.

maxLength: 128 · minLength: 1 · pattern: ^[\w-]+$

Returns

200

Successful operation.

JSON

success
boolean
required
data
object
required
- bookingDuration
  object
  required
  Staff duration override policy; it changes one appointment without changing the service’s standard duration.
  
  default: {"enabled":false,"maxMinutes":1440,"minMinutes":1,"stepMinutes":1}
  enabled
  boolean
  required
  default: false
  maxMinutes
  integer
  required
  maximum: 1440 · minimum: 1 · default: 1440
  minMinutes
  integer
  required
  maximum: 1440 · minimum: 1 · default: 1
  stepMinutes
  1
  or
  5
  or
  10
  or
  15
  or
  20
  or
  30
  +1 more
  required
  Permitted appointment duration increment; the selected duration must be divisible by this value.
  
  default: 1
- customFields
  array of
  object
  required
  Organization-defined intake fields with stable keys retained in recorded values.
  
  default: []
  help
  string | null
  required
  One line under the input, e.g. "Como aparece en la orden".
  
  maxLength: 200 · default: null
  key
  string
  required
  Stable custom-field key used in recorded intake values. Renaming a display label does not change this key.
  
  pattern: ^[a-z][a-z0-9_]{0,39}$
  label
  string
  required
  Display label shown to staff when entering this field.
  
  maxLength: 80 · minLength: 1
  options
  array of
  string
  required
  Choices of a select; empty for every other type.
  
  maxLength: 80 · minLength: 1 · default: []
  required
  boolean
  required
  Whether this active custom field requires a nonempty value during intake.
  
  default: false
  status
  active
  or
  archived
  required
  Archived fields stop being asked but keep the values already recorded.
  
  default: "active"
  type
  text
  or
  number
  or
  date
  or
  select
  or
  checkbox
  required
  Value type accepted by this custom configuration field.
- documentTypes
  array of
  object
  required
  Configured document types; inactive types remain valid on existing records.
  
  default: [{"code":"CC","description":"Colombianos de 18 años o más.","name":"Cédula de ciudadanía","status":"active"},{"code":"TI","description":"Colombianos de 7 a 17 años.","name":"Tarjeta de identidad","status":"active"},{"code":"RC","description":"Colombianos menores de 7 años.","name":"Registro civil","status":"active"},{"code":"CE","description":"Extranjeros residentes en Colombia.","name":"Cédula de extranjería","status":"active"},{"code":"PA","description":"Extranjeros sin documento colombiano.","name":"Pasaporte","status":"active"},{"code":"PEP","description":"Migrantes con PEP vigente.","name":"Permiso especial de permanencia","status":"active"},{"code":"PPT","description":"Migrantes venezolanos con PPT.","name":"Permiso por protección temporal","status":"active"},{"code":"NUIP","description":"El número del registro civil o la tarjeta de identidad.","name":"Número único de identificación personal","status":"active"},{"code":"CD","description":"Personal diplomático acreditado.","name":"Carné diplomático","status":"active"},{"code":"SC","description":"Extranjeros con trámite de refugio.","name":"Salvoconducto de permanencia","status":"active"},{"code":"NIT","description":"Empresas y personas jurídicas.","name":"Número de identificación tributaria","status":"active"},{"code":"DE","description":"El documento del país de origen.","name":"Documento de identidad extranjero","status":"active"},{"code":"CN","description":"Recién nacidos sin registro civil.","name":"Certificado de nacido vivo","status":"active"},{"code":"MS","description":"Menores sin ningún documento.","name":"Menor sin identificación","status":"active"},{"code":"AS","description":"Adultos sin ningún documento.","name":"Adulto sin identificación","status":"active"}]
  code
  string
  required
  Stable document-type code retained in patient records.
  
  pattern: ^[A-Z][A-Z0-9]{0,9}$
  description
  string
  required
  What the select's tooltip says, e.g. "Colombianos de 18 años o más".
  
  maxLength: 200 · default: ""
  name
  string
  required
  Display name of this catalog or configuration record.
  
  maxLength: 80 · minLength: 1
  status
  active
  or
  inactive
  required
  Inactive types stop being offered; records that use one stay valid.
  
  default: "active"
- fields
  object
  required
  Modes controlling which built-in intake fields are displayed or required.
  
  default: {"authorization":"optional","conversationUrl":"optional","document":"optional","email":"optional","notes":"optional","payer":"optional","phone":"optional","priority":"on"}
  authorization
  off
  or
  optional
  or
  required
  required
  Organization-defined authorization field configuration.
  
  default: "optional"
  conversationUrl
  off
  or
  optional
  required
  Configuration for displaying an optional conversation link during intake.
  
  default: "optional"
  document
  optional
  or
  required
  required
  Organization-defined patient document field configuration.
  
  default: "optional"
  email
  off
  or
  optional
  or
  required
  required
  Organization-defined email field configuration.
  
  default: "optional"
  notes
  off
  or
  optional
  or
  required
  required
  Organization-defined appointment notes field configuration.
  
  default: "optional"
  payer
  off
  or
  optional
  or
  required
  required
  Organization-defined payer field configuration.
  
  default: "optional"
  phone
  off
  or
  optional
  or
  required
  required
  Organization-defined telephone field configuration.
  
  default: "optional"
  priority
  off
  or
  on
  required
  Whether the appointment priority control is displayed during intake.
  
  default: "on"
- labels
  object
  required
  Organization-defined labels and examples for built-in intake fields.
  
  default: {"authorization":{"label":"N.º de autorización","placeholder":""},"document":{"label":"Documento","placeholder":"Número"},"email":{"label":"Correo","placeholder":"paciente@correo.com"},"name":{"label":"Nombre del paciente","placeholder":"Nombres y apellidos"},"notes":{"label":"Observaciones","placeholder":"Ej. Debe traer la autorización. No cancela copago."},"phone":{"label":"Teléfono","placeholder":"+57 300 000 0000"}}
  authorization
  object
  required
  Organization-defined authorization field configuration.
  
  default: {"label":"N.º de autorización","placeholder":""}
  label
  string
  required
  Display label shown to staff when entering this field.
  
  maxLength: 60 · minLength: 1
  placeholder
  string
  required
  Example or hint displayed inside the input before staff enter a value.
  
  maxLength: 120
  document
  object
  required
  Organization-defined patient document field configuration.
  
  default: {"label":"Documento","placeholder":"Número"}
  label
  string
  required
  Display label shown to staff when entering this field.
  
  maxLength: 60 · minLength: 1
  placeholder
  string
  required
  Example or hint displayed inside the input before staff enter a value.
  
  maxLength: 120
  email
  object
  required
  Organization-defined email field configuration.
  
  default: {"label":"Correo","placeholder":"paciente@correo.com"}
  label
  string
  required
  Display label shown to staff when entering this field.
  
  maxLength: 60 · minLength: 1
  placeholder
  string
  required
  Example or hint displayed inside the input before staff enter a value.
  
  maxLength: 120
  name
  object
  required
  Display name of this catalog or configuration record.
  
  default: {"label":"Nombre del paciente","placeholder":"Nombres y apellidos"}
  label
  string
  required
  Display label shown to staff when entering this field.
  
  maxLength: 60 · minLength: 1
  placeholder
  string
  required
  Example or hint displayed inside the input before staff enter a value.
  
  maxLength: 120
  notes
  object
  required
  Organization-defined appointment notes field configuration.
  
  default: {"label":"Observaciones","placeholder":"Ej. Debe traer la autorización. No cancela copago."}
  label
  string
  required
  Display label shown to staff when entering this field.
  
  maxLength: 60 · minLength: 1
  placeholder
  string
  required
  Example or hint displayed inside the input before staff enter a value.
  
  maxLength: 120
  phone
  object
  required
  Organization-defined telephone field configuration.
  
  default: {"label":"Teléfono","placeholder":"+57 300 000 0000"}
  label
  string
  required
  Display label shown to staff when entering this field.
  
  maxLength: 60 · minLength: 1
  placeholder
  string
  required
  Example or hint displayed inside the input before staff enter a value.
  
  maxLength: 120
- payerLabel
  string
  required
  Organization-specific display name for the payer selector.
  
  maxLength: 40 · minLength: 1 · default: "Entidad / EPS"
- object
  string
  required
  Stable resource discriminator identifying the response object kind.
- updatedAt
  string | null
  required
  ISO 8601 instant of the latest persisted change; null when this configuration has never been saved.
- version
  number
  required
  Persisted revision used to detect concurrent edits.
- payers
  array of
  object
  required
  Active payer booking policies and attended sites admitted by the organization’s current intake modules.
  
  bookingPolicy
  open
  or
  staff_only
  required
  Profile-declared rules for admitting and coordinating a booking.
  
  name
  string
  required
  Display name of this catalog or configuration record.
  
  sites
  array of
  string
  required
  The sites (IPS, sedes) the clinic serves for this payer, as the clinic writes them. Empty: no restriction. With entries, a patient whose site is not one of them is not served under this payer.
  
  sitesNote
  string | null
  required
  One line about the sites, e.g. "Solo IPS en Barranquilla".
}
error
null
required
metadata
object
required
- requestId
  string
  required
  Request correlation identifier, also sent as X-Request-Id.
}

400

INVALID_INPUT: The request does not match the published schema.
INVALID_APPOINTMENT_INTAKE: Correct the indicated patient or intake fields before booking.
INVALID_PATIENT_FIELDS: Correct the indicated patient fields before saving.
DURATION_CHANGE_OFF: This service does not allow changing appointment duration.
DURATION_NOT_ALLOWED: Select a duration allowed by this service.
STUDY_LENGTH_NOT_OFFERED: Select one of the study lengths this agenda offers.
INVALID_FILE_KIND: Select a supported attachment kind.
INVALID_FILE_NAME: Provide a valid attachment filename.
INVALID_ID_TOKEN: Provide a valid identity token.
INVALID_JSON: Send a valid JSON document.
INVALID_WINDOW: Provide a positive time window within the supported range.
UNEXPECTED_QUERY_PARAMETERS: Remove query parameters not declared by this operation.
INVALID_BODY: The request body could not be read. Send valid uncompressed JSON.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

401

UNAUTHORIZED: A valid access token is required.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

403

FORBIDDEN: The token does not authorize this operation.
ID_TOKEN_MISMATCH: The identity token does not match the authenticated user.
NOT_FILE_UPLOADER: Only the uploader may delete this attachment.
NOT_NOTE_AUTHOR: Only the author may edit or delete this note.
ORIGIN_NOT_ALLOWED: This request origin is not allowed.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

404

NOT_FOUND: The requested resource does not exist.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

405

HTTP_METHOD_NOT_ALLOWED: The HTTP method is not supported for this resource.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

409

PAYER_STAFF_ONLY: This payer requires booking by the organization team. Add the patient to the waitlist for review.
APPOINTMENT_NOT_REMINDABLE: Only an open future appointment with a patient email can receive a reminder.
APPOINTMENT_WITHOUT_PATIENT: Link a patient to this appointment before performing this action.
ARBOL_CATALOG_TOO_LARGE: The integration catalog exceeds the supported size. Narrow the catalog before retrying.
ARBOL_CONFIGURATION_REQUIRED: Configure the organization integration before using it.
NOTIFICATIONS_NOT_SET_UP: Patient emails need the notifications module turned on.
SAME_OFFERING: An agenda cannot take its own appointments.
SAME_SERVICE: A service cannot be merged into itself.
INVALID_HOLD_PAYLOAD: The held slot is malformed.
HOLD_NOT_ACTIVE: The hold is no longer active.
APPOINTMENT_CLOSED: A cancelled appointment cannot be edited.
APPOINTMENT_VERSION_MISMATCH: The appointment changed after it was loaded.
APPOINTMENT_NOT_MOVABLE: A closed appointment cannot be moved.
SERVICE_CHANGED: The new slot belongs to another service.
SCHEDULE_CHANGED: The selected time no longer matches the current schedule.
INVALID_AVAILABILITY_WINDOW: Availability windows must be positive and at most 31 days.
SERVICE_CAPACITY_EXCEEDED: This service already has as many appointments as it can run at once at that time.
RESOURCE_CAPACITY_EXCEEDED: The selected time is no longer available.
OVERBOOK_OUT_OF_RANGE: An overbooked appointment must start between yesterday and the booking horizon.
OVERBOOK_UNAVAILABLE: No active agenda can take this appointment.
STUDY_OVERBOOKING_NOT_ALLOWED: This study has an explicit capacity limit and requires an available ordinary slot.
INVALID_SLOT_TOKEN: Request a fresh available slot before booking.
BIRTH_DATE_REQUIRED: This service has an age rule: the patient's date of birth is required.
AGE_NOT_ELIGIBLE: The patient's age on that day is outside this service's age rule.
INTAKE_SETTINGS_VERSION_MISMATCH: Intake settings changed; reload before saving.
PAYER_NAME_TAKEN: Another payer already has that name.
PAYER_VERSION_MISMATCH: The payer changed; reload before saving.
LOCATION_VERSION_MISMATCH: The site changed after it was loaded.
PROFILE_VERSION_MISMATCH: The profile changed after it was loaded.
PROVIDER_DISABLED: Enable the provider integration before using it.
BINDING_VERSION_MISMATCH: Connection changed or is synchronizing; refresh and retry.
RESOURCE_VERSION_MISMATCH: The resource changed after it was loaded.
SCHEDULE_RULE_AGENDA_MISMATCH: The schedule rule belongs to another agenda.
SCHEDULE_RULE_EXPECTED_VERSION_REQUIRED: Expected version is required for an update.
SCHEDULE_RULE_VERSION_MISMATCH: The schedule rule changed after it was loaded.
SCHEDULE_RULES_CHANGED: The schedule changed after it was loaded.
SERVICE_VERSION_MISMATCH: The service changed after it was loaded.
OFFERING_VERSION_MISMATCH: The offering changed after it was loaded.
SAME_RESOURCE: An agenda cannot take its own appointments.
TARGET_INACTIVE: An archived agenda takes no appointments.
SLOT_REQUIRED: A hold or slot token is required.
ARBOL_SETTINGS_VERSION_MISMATCH: Arbol settings changed.
NOTIFICATION_SETTINGS_VERSION_MISMATCH: Notification settings changed; reload before saving.
ORGANIZATION_VERSION_MISMATCH: The organization changed; reload before saving.
PATIENT_DOCUMENT_TAKEN: Another patient has that document.
PATIENT_VERSION_MISMATCH: The patient changed after it was loaded.
DAILY_REPORT_TOO_LARGE: Daily report exceeds the supported size; no partial report was generated.
REPORT_SETTINGS_VERSION_MISMATCH: Report settings changed; reload before saving.
REPORT_NOTIFICATIONS_DISABLED: Enable the notifications module before sending a daily agenda.
REPORT_RECIPIENTS_REQUIRED: No eligible organization owner or additional delivery address is available for this agenda.
WAITLIST_ENTRY_VERSION_MISMATCH: The waitlist entry changed; reload before saving.
REMOVAL_JOB_CONFLICT: A removal is already active, or this idempotency key belongs to another decision.
FOLLOWUP_SETTINGS_VERSION_MISMATCH: Follow-up email settings changed; reload before saving.
FOLLOWUP_DISABLED: Turn this follow-up email on in the notification settings first.
FOLLOWUP_CONSENT_REQUIRED: The patient has not consented to this follow-up email for their current address.
PATIENT_EMAIL_REQUIRED: Record the patient's email before this action.
PATIENT_ARCHIVED: Restore the patient before this action.
RECALL_ALREADY_ACTIVE: The patient already has an active recall for this service.
RECALL_MONTH_PASSED: The recall's month has already passed.
RECALL_VISIT_REQUIRED: Enter the last visit: there is no attended appointment of this service for the patient.
RECALL_VISIT_IN_FUTURE: The last visit must be a past date.
RECALL_VERSION_MISMATCH: The recall changed after it was loaded.
SLOT_OFFER_NOT_ALLOWED: Only an open waiting-list entry of a registered patient can receive a slot offer.
SLOT_OFFER_MISMATCH: The slot belongs to another service or agenda than the entry asks for.
SLOT_OFFER_TOO_SOON: The slot starts too soon to hold it for the patient; offer a later one.
SLOT_OFFER_ALREADY_OPEN: This waiting-list entry already has an open slot offer.
SLOT_OFFER_CLOSED: The slot offer is no longer open.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

413

REQUEST_TOO_LARGE: The request exceeds the allowed size.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

415

UNSUPPORTED_MEDIA_TYPE: The request content type is not supported.
APPLICATION_JSON_REQUIRED: Send the request as application/json.
FILE_CONTENT_MISMATCH: The uploaded content does not match its declared file type.
UNSUPPORTED_CONTENT_ENCODING: Send an uncompressed request body.
UNSUPPORTED_FILE_TYPE: Select a supported attachment file type.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

426

UPGRADE_REQUIRED: Open the live channel with a WebSocket upgrade.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

429

RATE_LIMITED: The request rate limit was exceeded. Try again later.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

500

INTERNAL_ERROR: The service could not complete the operation.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

502

OUTCOME_UNKNOWN: The operation may have been applied; check its result before repeating it.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

503

UPSTREAM_UNAVAILABLE: The upstream service could not complete the request.
ARBOL_RESPONSE_TOO_LARGE: The integration response exceeds the supported size.
ARBOL_UNAVAILABLE: The integration service is temporarily unavailable. Retry later.
REMOVAL_WORKFLOW_UNAVAILABLE: Durable removal is unavailable here; use the bounded manual removal operations.
ARBOL_REFUSED: The integration service rejected this request. Review its configuration.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}

504

UPSTREAM_TIMEOUT: The upstream service did not respond before its deadline.

JSON

error
required
One of the following:
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
}