---
title: "Update Waitlist Entry"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.getarbol.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Waitlist Entry

Path: Agenda API › Waitlist

`PATCH /v1/agenda/waitlist/{waitlistEntryId}`

An authenticated staff user amends one existing waitlist entry with expectedVersion, preserving its ID, patient, service and queue position. Omitted preferences, professional, priority and appointment association are preserved. Send the complete consented date/time window when replacing preferences. Use resourceId:null only to clear the Agenda resource filter and retain any external or multiple-professional restriction explicitly in note. Sends and queues no messages, emails, offers or patient follow-ups and never changes a booking. Requires a user login with agenda:waitlist:write; service tokens and native agents cannot call it.

- **Scope:** `agenda:waitlist:write`
- **Credentials:** a person's access token only; API keys and client-credentials tokens get `403`
- **Effect:** writes; idempotent, safe to retry
- **Limits:** request body up to 256 KB, response up to 8 MB
- **CLI:** `arbol agenda waitlist update` · **MCP tool:** `agenda_waitlist_update`

## Authentication

- `arbolHuman`, oauth2, scopes: `agenda:waitlist:write`

## Path parameters

- `waitlistEntryId` (`agenda.waitlist.update.path.waitlistEntryId`; string, required) — Organization-owned waiting-list entry identifier.
  - pattern `^wle_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`

## Request body

_Required._

- `expectedVersion` (`agenda.waitlist.update.expectedVersion`; integer, required) — Version last read by the caller. The mutation fails if another writer has changed this record.
- `appointmentId` (`agenda.waitlist.update.appointmentId`; string | null, optional) — Appointment associated with this waiting-list entry; null clears the association.
  - pattern `^eng_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`
- `conversationUrl` (`agenda.waitlist.update.conversationUrl`; string | null, optional) — HTTPS link to the originating Arbol conversation on an admitted product hostname; null when absent.
  - format `uri`; maxLength 500
- `preferences` (`agenda.waitlist.update.preferences`; object, optional)
  - `from` (`agenda.waitlist.update.preferences.from`; string | null, optional) — From this local date (YYYY-MM-DD).
    - format `date`; default `null`
  - `times` (`agenda.waitlist.update.preferences.times`; string | null, optional) — "Martes y jueves en la mañana".
    - default `null`
  - `to` (`agenda.waitlist.update.preferences.to`; string | null, optional) — Until this local date (YYYY-MM-DD).
    - format `date`; default `null`
- `resourceId` (`agenda.waitlist.update.resourceId`; string | null, optional) — Stable srs-prefixed Scheduling record identifier; ownership is checked in the authenticated organization.
  - pattern `^srs_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`
- `resourceName` (`agenda.waitlist.update.resourceName`; string, optional) — The requested professional or agenda name. Resolves only one active agenda offering this service, ignoring accents and professional titles. If resourceId is supplied too, it must identify the same agenda. For a documented external professional absent from Agenda, omit resourceName/resourceId and explicitly restrict the manual request to that professional in note.
- `note` (`agenda.waitlist.update.note`; string | null, optional) — Desk note attached to the waiting-list entry; null means no note is recorded.
- `priority` (`agenda.waitlist.update.priority`; string, optional) — Whether the waiting-list entry requests normal handling or an urgent appointment.
  - one of `"normal"`, `"urgent"`
- `status` (`agenda.waitlist.update.status`; string, optional) — Current waiting-list state: waiting, contacted, booked, expired or removed.
  - one of `"waiting"`, `"offered"`, `"booked"`, `"cancelled"`

## Example request

```json
{
  "appointmentId": "string",
  "expectedVersion": 1,
  "conversationUrl": "http://example.com",
  "preferences": {
    "from": null,
    "times": null,
    "to": null
  },
  "resourceId": "string",
  "resourceName": "string",
  "note": "string",
  "priority": "normal",
  "status": "waiting"
}
```

## Code samples

### cURL

```bash
curl "https://api.getarbol.com/v1/agenda/waitlist/<waitlistEntryId>" \
  --request PATCH \
  --header "Authorization: Bearer $ARBOL_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "expectedVersion": 1
}'
```

### TypeScript

```typescript
import { createClient } from "@arbol-ai/sdk";

const arbol = createClient({
  baseUrl: "https://api.getarbol.com",
  token: process.env.ARBOL_API_KEY!,
});

const { data } = await arbol.agenda.waitlist.update({
  expectedVersion: 1,
  waitlistEntryId: "<waitlistEntryId>",
});
```

### Rust

```rust
use arbol_sdk::{types, Client, Credential};

let arbol = Client::new(Credential::ApiKey(std::env::var("ARBOL_API_KEY")?))?;

let data = arbol
    .agenda()
    .waitlist()
    .update(&types::AgendaWaitlistUpdateInput {
        expected_version: 1,
        waitlist_entry_id: "<waitlistEntryId>".into(),
        appointment_id: None,
        conversation_url: None,
        preferences: None,
        resource_id: None,
        resource_name: None,
        note: None,
        priority: None,
        status: None,
    })
    .await?;
```

### CLI

```bash
arbol agenda waitlist update '<waitlistEntryId>' --expected-version 1
```

### MCP

```json
{
  "name": "agenda_waitlist_update",
  "arguments": {
    "expectedVersion": 1,
    "waitlistEntryId": "<waitlistEntryId>"
  }
}
```

## Responses

### 200

Successful operation.

#### Example

```json
{
  "success": true,
  "data": {
    "appointmentId": "string",
    "channel": "calendar",
    "contactId": "string",
    "conversationUrl": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "id": "string",
    "note": "string",
    "object": "scheduling.waitlist_entry",
    "offeringId": "string",
    "patient": {
      "document": "string",
      "documentNumber": "string",
      "documentType": "string",
      "id": "string",
      "name": "string",
      "phone": "string"
    },
    "payer": "string",
    "preferences": {},
    "priority": "normal",
    "reason": "manual",
    "resourceId": "string",
    "schemaVersion": 1,
    "serviceId": "string",
    "status": "waiting",
    "updatedAt": "2019-08-24T14:15:22Z",
    "version": 1
  },
  "error": null,
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.200.success`; boolean, required)
  - one of `true`
- `data` (`agenda.waitlist.update.response.200.data`; object, required)
  - `appointmentId` (`agenda.waitlist.update.response.200.data.appointmentId`; string | null, required) — The appointment it relates to: a priority to bring forward.
  - `channel` (`agenda.waitlist.update.response.200.data.channel`; string, required) — Who added it: the desk ("calendar") or the WhatsApp agent.
    - one of `"calendar"`, `"agent"`
  - `contactId` (`agenda.waitlist.update.response.200.data.contactId`; string | null, required) — External contact reference associated with this booking; null when it has no external contact.
    - pattern `^cnt_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`
  - `conversationUrl` (`agenda.waitlist.update.response.200.data.conversationUrl`; string | null, required) — The agent's WhatsApp conversation.
  - `createdAt` (`agenda.waitlist.update.response.200.data.createdAt`; string, required) — Instant when the scheduling record was first created.
    - format `date-time`
  - `createdBy` (`agenda.waitlist.update.response.200.data.createdBy`; string | null, required) — Principal reference of whoever added it; null for older entries.
  - `id` (`agenda.waitlist.update.response.200.data.id`; string, required) — Organization-owned waiting-list entry identifier.
    - pattern `^wle_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`
  - `note` (`agenda.waitlist.update.response.200.data.note`; string | null, required) — Desk note attached to the waiting-list entry; null means no note is recorded.
  - `object` (`agenda.waitlist.update.response.200.data.object`; string, required) — scheduling.waitlist_entry identifies this waiting-list entry.
  - `offeringId` (`agenda.waitlist.update.response.200.data.offeringId`; string | null, required) — Exact offering requested by this waiting-list entry; null when it targets the service across eligible agendas.
    - pattern `^off_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`
  - `patient` (`agenda.waitlist.update.response.200.data.patient`; object | null, required) — Who is waiting, as their record reads now; null for a contact-only entry.
    - `document` (`agenda.waitlist.update.response.200.data.patient.document`; string | null, required, deprecated) — Deprecated: use `documentNumber`. Answered until 2027-01-28.
    - `documentNumber` (`agenda.waitlist.update.response.200.data.patient.documentNumber`; string | null, required) — Patient document number; null when the patient has no recorded document.
    - `documentType` (`agenda.waitlist.update.response.200.data.patient.documentType`; string | null, required) — Document category paired with the patient document number; null when unrecorded.
    - `id` (`agenda.waitlist.update.response.200.data.patient.id`; string, required) — Registered patient linked to this waiting-list entry.
      - pattern `^pat_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`
    - `name` (`agenda.waitlist.update.response.200.data.patient.name`; string, required) — Patient name displayed to the scheduling team.
    - `phone` (`agenda.waitlist.update.response.200.data.patient.phone`; string | null, required) — Patient contact telephone number; null when no number was recorded.
  - `payer` (`agenda.waitlist.update.response.200.data.payer`; string | null, required) — The payer the patient named.
  - `preferences` (`agenda.waitlist.update.response.200.data.preferences`; object, required) — Patient availability preferences retained with the waiting-list entry.
  - `priority` (`agenda.waitlist.update.response.200.data.priority`; string, required) — Whether the waiting-list entry requests normal handling or an urgent appointment.
    - one of `"normal"`, `"urgent"`
  - `reason` (`agenda.waitlist.update.response.200.data.reason`; string, required) — Added by hand, a payer only the team books, or a priority to bring forward.
    - one of `"manual"`, `"payer_review"`, `"priority"`
  - `resourceId` (`agenda.waitlist.update.response.200.data.resourceId`; string | null, required) — Agenda identifier within the authenticated organization.
    - pattern `^srs_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`
  - `schemaVersion` (`agenda.waitlist.update.response.200.data.schemaVersion`; number, required) — Revision of the public record shape; separate from the record version used for concurrency control.
  - `serviceId` (`agenda.waitlist.update.response.200.data.serviceId`; string, required) — Service identifier within the authenticated organization.
    - pattern `^svc_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$`
  - `status` (`agenda.waitlist.update.response.200.data.status`; string, required) — Current waiting-list state: waiting, contacted, booked, expired or removed.
    - one of `"waiting"`, `"offered"`, `"booked"`, `"expired"`, `"cancelled"`
  - `updatedAt` (`agenda.waitlist.update.response.200.data.updatedAt`; string, required) — Instant of the latest change to this scheduling record.
    - format `date-time`
  - `version` (`agenda.waitlist.update.response.200.data.version`; integer, required) — Current record revision; pass it unchanged as expectedVersion for a guarded mutation.
- `error` (`agenda.waitlist.update.response.200.error`; unknown, required)
- `metadata` (`agenda.waitlist.update.response.200.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.200.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 400

- `INVALID_INPUT`: The request does not match the published schema.
- `WAITLIST_SERVICE_UNAVAILABLE`: Correct serviceId using serviceId from bookingOfferings.list. Search a short service term such as neurología, then inspect the matching service name. Never invent an ID. No waiting-list entry was changed; correct this field and retry with the same consent.
- `WAITLIST_RESOURCE_UNAVAILABLE`: The requested professional is not an active agenda for this service. Use resourceName for the requested professional or copy agendas[].id from bookingOfferings.list, never the offering id. If both are supplied, they must agree. No waiting-list entry was changed. Correct the reference with the same consent. If a verified provider professional is absent from Agenda, omit resourceName, clear resourceId and explicitly restrict the manual request to that professional in note.
- `WAITLIST_RESOURCE_AMBIGUOUS`: More than one active agenda matches resourceName for this service. Read bookingOfferings.list and provide the complete requested professional name or its agendas[].id. No waiting-list entry was changed.
- `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.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INVALID_INPUT",
    "message": "string",
    "retryable": false,
    "data": {
      "issues": [
        {
          "path": "string",
          "message": "string"
        }
      ]
    }
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.400.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.400.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.400.error`; AgendaUpdateWaitlistEntryBadRequestFailure, required)
  - one of: `InvalidInputFailure`, `AgendaWaitlistServiceUnavailableFailure`, `AgendaWaitlistResourceUnavailableFailure`, `AgendaWaitlistResourceAmbiguousFailure`, `AgendaInvalidAppointmentIntakeFailure`, `AgendaInvalidPatientFieldsFailure`, `AgendaDurationChangeOffFailure`, `AgendaDurationNotAllowedFailure`, `AgendaStudyLengthNotOfferedFailure`, `AgendaInvalidFileKindFailure`, `AgendaInvalidFileNameFailure`, `AgendaInvalidIdTokenFailure`, `AgendaInvalidJsonFailure`, `AgendaInvalidWindowFailure`, `AgendaUnexpectedQueryParametersFailure`, `AgendaInvalidBodyFailure`
  - discriminator: `code`
- `metadata` (`agenda.waitlist.update.response.400.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.400.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 401

`UNAUTHORIZED`: A valid access token is required.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.401.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.401.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.401.error`; object, required) — A valid access token is required.
  - `code` (`agenda.waitlist.update.response.401.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNAUTHORIZED"`
  - `message` (`agenda.waitlist.update.response.401.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`agenda.waitlist.update.response.401.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`agenda.waitlist.update.response.401.error.data`; object, required) — No fields.
- `metadata` (`agenda.waitlist.update.response.401.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.401.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 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.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "FORBIDDEN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.403.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.403.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.403.error`; AgendaUpdateWaitlistEntryForbiddenFailure, required)
  - one of: `ForbiddenFailure`, `AgendaIdTokenMismatchFailure`, `AgendaNotFileUploaderFailure`, `AgendaNotNoteAuthorFailure`, `AgendaOriginNotAllowedFailure`
  - discriminator: `code`
- `metadata` (`agenda.waitlist.update.response.403.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.403.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 404

`RECORD_NOT_FOUND`: The requested record does not exist.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RECORD_NOT_FOUND",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.404.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.404.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.404.error`; object, required) — The requested record does not exist.
  - `code` (`agenda.waitlist.update.response.404.error.code`; string, required) — The failure code, stable across releases.
    - one of `"RECORD_NOT_FOUND"`
  - `message` (`agenda.waitlist.update.response.404.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`agenda.waitlist.update.response.404.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`agenda.waitlist.update.response.404.error.data`; object, required) — No fields.
- `metadata` (`agenda.waitlist.update.response.404.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.404.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 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.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "PAYER_STAFF_ONLY",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.409.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.409.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.409.error`; AgendaUpdateWaitlistEntryConflictFailure, required)
  - one of: `AgendaPayerStaffOnlyFailure`, `AgendaAppointmentNotRemindableFailure`, `AgendaAppointmentWithoutPatientFailure`, `AgendaArbolCatalogTooLargeFailure`, `AgendaArbolConfigurationRequiredFailure`, `AgendaNotificationsNotSetUpFailure`, `AgendaSameOfferingFailure`, `AgendaSameServiceFailure`, `AgendaInvalidHoldPayloadFailure`, `AgendaHoldNotActiveFailure`, `AgendaAppointmentClosedFailure`, `AgendaAppointmentVersionMismatchFailure`, `AgendaAppointmentNotMovableFailure`, `AgendaServiceChangedFailure`, `AgendaScheduleChangedFailure`, `AgendaInvalidAvailabilityWindowFailure`, `AgendaServiceCapacityExceededFailure`, `AgendaResourceCapacityExceededFailure`, `AgendaOverbookOutOfRangeFailure`, `AgendaOverbookUnavailableFailure`, `AgendaStudyOverbookingNotAllowedFailure`, `AgendaInvalidSlotTokenFailure`, `AgendaBirthDateRequiredFailure`, `AgendaAgeNotEligibleFailure`, `AgendaIntakeSettingsVersionMismatchFailure`, `AgendaPayerNameTakenFailure`, `AgendaPayerVersionMismatchFailure`, `AgendaLocationVersionMismatchFailure`, `AgendaProfileVersionMismatchFailure`, `AgendaProviderDisabledFailure`, `AgendaBindingVersionMismatchFailure`, `AgendaResourceVersionMismatchFailure`, `AgendaScheduleRuleAgendaMismatchFailure`, `AgendaScheduleRuleExpectedVersionRequiredFailure`, `AgendaScheduleRuleVersionMismatchFailure`, `AgendaScheduleRulesChangedFailure`, `AgendaServiceVersionMismatchFailure`, `AgendaOfferingVersionMismatchFailure`, `AgendaSameResourceFailure`, `AgendaTargetInactiveFailure`, `AgendaSlotRequiredFailure`, `AgendaArbolSettingsVersionMismatchFailure`, `AgendaNotificationSettingsVersionMismatchFailure`, `AgendaOrganizationVersionMismatchFailure`, `AgendaPatientDocumentTakenFailure`, `AgendaPatientVersionMismatchFailure`, `AgendaDailyReportTooLargeFailure`, `AgendaReportSettingsVersionMismatchFailure`, `AgendaReportNotificationsDisabledFailure`, `AgendaReportRecipientsRequiredFailure`, `AgendaWaitlistEntryVersionMismatchFailure`, `AgendaRemovalJobConflictFailure`, `AgendaFollowupSettingsVersionMismatchFailure`, `AgendaFollowupDisabledFailure`, `AgendaFollowupConsentRequiredFailure`, `AgendaPatientEmailRequiredFailure`, `AgendaPatientArchivedFailure`, `AgendaRecallAlreadyActiveFailure`, `AgendaRecallMonthPassedFailure`, `AgendaRecallVisitRequiredFailure`, `AgendaRecallVisitInFutureFailure`, `AgendaRecallVersionMismatchFailure`, `AgendaSlotOfferNotAllowedFailure`, `AgendaSlotOfferMismatchFailure`, `AgendaSlotOfferTooSoonFailure`, `AgendaSlotOfferAlreadyOpenFailure`, `AgendaSlotOfferClosedFailure`
  - discriminator: `code`
- `metadata` (`agenda.waitlist.update.response.409.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.409.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 413

`REQUEST_TOO_LARGE`: The request exceeds the allowed size.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "REQUEST_TOO_LARGE",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.413.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.413.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.413.error`; object, required) — The request exceeds the allowed size.
  - `code` (`agenda.waitlist.update.response.413.error.code`; string, required) — The failure code, stable across releases.
    - one of `"REQUEST_TOO_LARGE"`
  - `message` (`agenda.waitlist.update.response.413.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`agenda.waitlist.update.response.413.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`agenda.waitlist.update.response.413.error.data`; object, required) — No fields.
- `metadata` (`agenda.waitlist.update.response.413.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.413.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 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.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.415.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.415.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.415.error`; AgendaUpdateWaitlistEntryUnsupportedMediaTypeFailure, required)
  - one of: `UnsupportedMediaTypeFailure`, `AgendaApplicationJsonRequiredFailure`, `AgendaFileContentMismatchFailure`, `AgendaUnsupportedContentEncodingFailure`, `AgendaUnsupportedFileTypeFailure`
  - discriminator: `code`
- `metadata` (`agenda.waitlist.update.response.415.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.415.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 426

`UPGRADE_REQUIRED`: Open the live channel with a WebSocket upgrade.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPGRADE_REQUIRED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.426.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.426.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.426.error`; object, required) — Open the live channel with a WebSocket upgrade.
  - `code` (`agenda.waitlist.update.response.426.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPGRADE_REQUIRED"`
  - `message` (`agenda.waitlist.update.response.426.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`agenda.waitlist.update.response.426.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`agenda.waitlist.update.response.426.error.data`; object, required) — No fields.
- `metadata` (`agenda.waitlist.update.response.426.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.426.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 429

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

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RATE_LIMITED",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.429.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.429.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.429.error`; object, required) — The request rate limit was exceeded. Try again later.
  - `code` (`agenda.waitlist.update.response.429.error.code`; string, required) — The failure code, stable across releases.
    - one of `"RATE_LIMITED"`
  - `message` (`agenda.waitlist.update.response.429.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`agenda.waitlist.update.response.429.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`agenda.waitlist.update.response.429.error.data`; object, required) — No fields.
- `metadata` (`agenda.waitlist.update.response.429.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.429.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 500

`INTERNAL_ERROR`: The service could not complete the operation.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.500.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.500.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.500.error`; object, required) — The service could not complete the operation.
  - `code` (`agenda.waitlist.update.response.500.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INTERNAL_ERROR"`
  - `message` (`agenda.waitlist.update.response.500.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`agenda.waitlist.update.response.500.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`agenda.waitlist.update.response.500.error.data`; object, required) — No fields.
- `metadata` (`agenda.waitlist.update.response.500.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.500.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 502

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

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "OUTCOME_UNKNOWN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.502.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.502.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.502.error`; object, required) — The operation may have been applied; check its result before repeating it.
  - `code` (`agenda.waitlist.update.response.502.error.code`; string, required) — The failure code, stable across releases.
    - one of `"OUTCOME_UNKNOWN"`
  - `message` (`agenda.waitlist.update.response.502.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`agenda.waitlist.update.response.502.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`agenda.waitlist.update.response.502.error.data`; object, required) — No fields.
- `metadata` (`agenda.waitlist.update.response.502.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.502.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 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.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_UNAVAILABLE",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.503.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.503.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.503.error`; AgendaUpdateWaitlistEntryServiceUnavailableFailure, required)
  - one of: `UpstreamUnavailableFailure`, `AgendaArbolResponseTooLargeFailure`, `AgendaArbolUnavailableFailure`, `AgendaRemovalWorkflowUnavailableFailure`, `AgendaArbolRefusedFailure`
  - discriminator: `code`
- `metadata` (`agenda.waitlist.update.response.503.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.503.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 504

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

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_TIMEOUT",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`agenda.waitlist.update.response.504.success`; boolean, required)
  - one of `false`
- `data` (`agenda.waitlist.update.response.504.data`; unknown, required)
- `error` (`agenda.waitlist.update.response.504.error`; object, required) — The upstream service did not respond before its deadline.
  - `code` (`agenda.waitlist.update.response.504.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPSTREAM_TIMEOUT"`
  - `message` (`agenda.waitlist.update.response.504.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`agenda.waitlist.update.response.504.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`agenda.waitlist.update.response.504.error.data`; object, required) — No fields.
- `metadata` (`agenda.waitlist.update.response.504.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`agenda.waitlist.update.response.504.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.


Source: https://docs.getarbol.com/api/agenda/waitlist/update/index.md
