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

# Скасувати запис

> Скасувати запис на забір крові

Скасуй запис, встановивши для нього статус `cancelled`. Скасувати можна лише записи, для яких ще не підтверджено забір крові.

Скасування запису, який уже має статус `cancelled`, повертає `200` із цим записом і нічого не зберігає — повторне скасування не фіксується. Відповідь містить `Idempotent-Replayed: true`, тож ти зможеш відрізнити повторний запит від виклику, який виконав дію. Повторний запит з **іншим** `cancellation_reason` натомість повертає `409`: збережена причина ніколи не перезаписується. Див. [Ідемпотентність](https://docs.anivahealth.com/uk/concepts/idempotency.md).

> [!WARNING]
>
> Запис не можна скасувати після підтвердження забору крові — у такому разі повертається `409
>     Conflict`.

Потребує області доступу `appointments_schedule` або `appointments_manage`.

## Запит

### Параметри шляху

**id** `string` *required*

Унікальний ідентифікатор (UUID) запису, який потрібно скасувати.

### Параметри тіла запиту

Тіло запиту необов’язкове — не надсилай його взагалі, щоб скасувати без зазначення причини.

**cancellation\_reason** `string`

Причина скасування у вільній формі, до 500 символів (наприклад, `Patient no-show`). Зберігається
в записі та повертається як `cancellation_reason` у цьому й подальших запитах на читання.

## Відповідь

У разі успіху API повертає `200 OK` зі скасованим записом і вбудованим профілем.

**id** `string` *required*

Унікальний ідентифікатор запису (UUID).

**profile\_id** `string` *required*

UUID профілю, до якого належить цей запис.

**location\_id** `string`

UUID локації тестування, де відбувається забір крові.

**scheduled\_at** `string`

Заплановані дата й час запису в UTC (ISO 8601 із суфіксом `Z`, наприклад
`2026-05-15T10:30:00Z`). Може бути `null`.

**status** `string` *required*

Статус запису. Після успішного скасування матиме значення `cancelled`.

**cancellation\_reason** `string`

Причина скасування у вільній формі, зафіксована під час скасування запису (наприклад, неявка, пізнє скасування,
«Помилка. Потрібно повторити»). `null`, якщо `status` не дорівнює `cancelled`.

**results\_ready\_emails** `string[]` *required*

Електронні адреси в нижньому регістрі, на кожну з яких надходить один лист, коли всі лабораторні результати стають остаточними. Порожньо, якщо вимкнено. Див.
[Листи про готовність результатів](https://docs.anivahealth.com/uk/concepts/results.md#listi-pro-gotovnist-rezultativ).

**draw\_method** `string` *required*

Спосіб забору крові: `capillary` (із пальця або плеча в мікротейнери) або `venous` (із вени
у пробірки). Це спосіб, указаний у записі, або `default_draw_method` його
[локації](https://docs.anivahealth.com/uk/concepts/locations.md). Після забору крові — це фактично використаний спосіб.

**created\_at** `string` *required*

Часова мітка ISO 8601 створення запису.

**updated\_at** `string`

Часова мітка ISO 8601 останнього оновлення. Може бути `null`.

**profile** `object` *required*

Профіль пацієнта, пов’язаний із цим записом.

**Профіль**

**id** `string`

Унікальний ідентифікатор профілю (UUID).

**handle** `string`

Нікнейм або ім’я користувача профілю. Може бути `null`.

**first\_name** `string`

Ім’я. Може бути `null`.

**last\_name** `string`

Прізвище. Може бути `null`.

**email** `string`

Електронна адреса. Може бути `null`.

**phone** `string`

Номер телефону у форматі E.164. Може бути `null`.

**sex** `integer`

Біологічна стать за стандартом ISO/IEC 5218. Може бути `null`.

**date\_of\_birth** `string`

Дата народження у форматі `YYYY-MM-DD`. Може бути `null`.

**height** `number`

Зріст у сантиметрах. Може бути `null`.

**weight** `number`

Вага в кілограмах. Може бути `null`.

**language** `string`

Бажана мова: один із 32 кодів у [Створити профіль](https://docs.anivahealth.com/uk/api/profiles/create-profile.md).

**transactional\_emails\_enabled** `boolean`

Чи отримує цей профіль транзакційні (програмні) листи. Може бути `null`.

**created\_at** `string`

Часова мітка ISO 8601 створення профілю.

**updated\_at** `string`

Часова мітка ISO 8601 останнього оновлення профілю. Може бути `null`.

**panels** `AppointmentPanel[]` *required*

Панелі, які були додані до цього запису до скасування. Переглянь деталі панелі (назву,
біомаркери) через [Список панелей](https://docs.anivahealth.com/uk/api/panels/list-panels.md).

**Поля доданої панелі**

**panel\_id** `string`

UUID панелі — звіряй зі [Списком панелей](https://docs.anivahealth.com/uk/api/panels/list-panels.md).

**added\_at** `string`

Часова мітка ISO 8601 першого додавання панелі до цього запису.

**individual\_biomarkers** `AppointmentIndividualBiomarker[]` *required*

Окремі біомаркери, додані до цього запису поза межами панелей (див. [Додати окремі
біомаркери](https://docs.anivahealth.com/uk/api/appointments/add-individual-biomarkers.md)). Звіряй кожен `biomarker_id`
зі [Списком біомаркерів](https://docs.anivahealth.com/uk/api/biomarkers/list-biomarkers.md), щоб отримати дані для відображення.

**Поля окремого біомаркера**

**biomarker\_id** `integer`

Ідентифікатор біомаркера — звіряй зі
[Списком біомаркерів](https://docs.anivahealth.com/uk/api/biomarkers/list-biomarkers.md).

**added\_at** `string`

Часова мітка ISO 8601 першого додавання біомаркера до цього запису.

**shipments** `AppointmentShipmentLink[]` *required*

Відправлення, які були прив’язані до цього запису до скасування. Кожен `id` можна звірити
через [Отримати відправлення](https://docs.anivahealth.com/uk/api/shipments/get-shipment.md).

**Поля прив’язки відправлення**

**id** `string`

Ідентифікатор посилання на відправлення — звіряй через
[Отримати відправлення](https://docs.anivahealth.com/uk/api/shipments/get-shipment.md).

**added\_at** `string`

Часова мітка ISO 8601 першої прив’язки відправлення до цього запису.

**lab\_codes** `string[]` *required*

Лабораторні коди (штрихкоди пробірок), зафіксовані для цього запису, у порядку сканування. Порожньо до підтвердження
забору крові. Венозний забір крові має один код, надрукований на кожній пробірці; капілярний забір крові має по одному
коду на кожен мікротейнер. Результати й документи в [Отримати результати](https://docs.anivahealth.com/uk/api/appointments/get-results.md) посилаються
на ці коди через `lab_code`.

## Відповіді з помилками

| Статус | Опис |
| - | - |
| `400` | Некоректний формат ID, пошкоджене тіло запиту або `cancellation_reason` перевищує 500 символів. |
| `403` | Заборонено — твій API-ключ не має доступу до цієї операції або запис поза межами твого контексту доступу. |
| `404` | Запис не знайдено. |
| `409` | Забір крові вже підтверджено або запис уже скасовано з іншою причиною. |
| `500` | Внутрішня помилка сервера. |

```bash cURL theme={null}
curl --request DELETE \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (with a reason) theme={null}
curl --request DELETE \
  --url https://anivahealth.com/api/v1/appointments/c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "cancellation_reason": "Patient no-show"
  }'
```

```json 200 theme={null}
{
  "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
  "scheduled_at": "2026-05-15T10:30:00Z",
  "status": "cancelled",
  "cancellation_reason": "Patient no-show",
  "results_ready_emails": [],
  "draw_method": "venous",
  "created_at": "2026-04-01T09:45:00Z",
  "updated_at": "2026-04-10T12:00:00Z",
  "profile": {
    "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "handle": null,
    "first_name": "Maria",
    "last_name": "Schmidt",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "height": 168,
    "weight": 65,
    "language": "de",
    "transactional_emails_enabled": true,
    "created_at": "2026-04-01T09:14:32Z",
    "updated_at": null
  },
  "panels": [
    {
      "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
      "added_at": "2026-04-01T09:50:00Z"
    }
  ],
  "individual_biomarkers": [],
  "shipments": [],
  "lab_codes": []
}
```

```json 409 theme={null}
{
  "error": "This appointment is already cancelled with a different cancellation_reason. Re-send the recorded reason, or omit it, to read the cancelled appointment back."
}
```

```json 404 theme={null}
{
  "error": "Appointment not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.