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

# Cancel·la una cita

> Cancel·la una cita d'extracció de sang

Cancel·la una cita establint-ne l'estat a `cancelled`. Només es poden cancel·lar les cites que encara no tinguin l'extracció de sang confirmada.

Cancel·lar una cita que ja té l'estat `cancelled` retorna `200` amb la cita i no escriu res — no es registra cap segona cancel·lació. La resposta inclou `Idempotent-Replayed: true` perquè puguis distingir una repetició de la crida que ha fet l'acció. Una repetició amb un `cancellation_reason` **diferent** retorna `409`: el motiu registrat no se sobreescriu mai. Consulta [Idempotència](https://docs.anivahealth.com/ca/concepts/idempotency.md).

> [!WARNING]
>
> Les cites no es poden cancel·lar un cop confirmada l'extracció de sang — això retorna `409
>     Conflict`.

Requereix l'àmbit `appointments_schedule` o `appointments_manage`.

## Sol·licitud

### Paràmetres de ruta

**id** `string` *required*

Identificador únic (UUID) de la cita que vols cancel·lar.

### Paràmetres del cos

El cos és opcional — no enviïs cap cos per cancel·lar sense registrar cap motiu.

**cancellation\_reason** `string`

Motiu en text lliure de la cancel·lació, de fins a 500 caràcters (p. ex., `Patient no-show`). Es desa a
la cita i es retorna com a `cancellation_reason` en aquesta lectura i en les posteriors.

## Resposta

Si té èxit, l'API retorna `200 OK` amb la cita cancel·lada i el seu perfil incrustat.

**id** `string` *required*

Identificador únic de la cita (UUID).

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

UUID del perfil al qual pertany aquesta cita.

**location\_id** `string`

UUID de la ubicació de proves on es fa l'extracció de sang.

**scheduled\_at** `string`

Data i hora programades de la cita com a instant UTC (ISO 8601 amb el sufix `Z`, p. ex.,
`2026-05-15T10:30:00Z`). Pot ser `null`.

**status** `string` *required*

Estat de la cita. Serà `cancelled` després d'una cancel·lació correcta.

**cancellation\_reason** `string`

Motiu en text lliure registrat en cancel·lar la cita (p. ex., absència, cancel·lació tardana,
«Error. Cal repetir»). `null` llevat que `status` sigui `cancelled`.

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

Adreces que reben un correu electrònic cadascuna quan tots els resultats del laboratori són definitius, en minúscules. Buit quan està desactivat. Consulta
[Correus electrònics de resultats a punt](https://docs.anivahealth.com/ca/concepts/results.md#correus-d-avis-de-resultats-a-punt).

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

Com es fa l'extracció de sang: `capillary` (de la punta del dit o de la part superior del braç, en microtubs) o `venous` (de la vena,
en tubs). És el mètode definit a la cita o, si no n'hi ha, el `default_draw_method` de la seva
[ubicació](https://docs.anivahealth.com/ca/concepts/locations.md). Després de l'extracció de sang, és el mètode que s'ha fet servir.

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

Marca de temps ISO 8601 de quan es va crear la cita.

**updated\_at** `string`

Marca de temps ISO 8601 de l'última actualització. Pot ser `null`.

**profile** `object` *required*

El perfil del pacient associat a aquesta cita.

**perfil**

**id** `string`

Identificador únic del perfil (UUID).

**handle** `string`

Àlies o nom d'usuari del perfil. Pot ser `null`.

**first\_name** `string`

Nom. Pot ser `null`.

**last\_name** `string`

Cognom. Pot ser `null`.

**email** `string`

Adreça electrònica. Pot ser `null`.

**phone** `string`

Número de telèfon en format E.164. Pot ser `null`.

**sex** `integer`

Sexe biològic segons ISO/IEC 5218. Pot ser `null`.

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

Data de naixement en format `YYYY-MM-DD`. Pot ser `null`.

**height** `number`

Alçada en centímetres. Pot ser `null`.

**weight** `number`

Pes en quilograms. Pot ser `null`.

**language** `string`

Idioma preferit: un dels 32 codis a [Crea un perfil](https://docs.anivahealth.com/ca/api/profiles/create-profile.md).

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

Indica si aquest perfil rep correus electrònics transaccionals (programàtics). Pot ser `null`.

**created\_at** `string`

Marca de temps ISO 8601 de quan es va crear el perfil.

**updated\_at** `string`

Marca de temps ISO 8601 de l'última actualització del perfil. Pot ser `null`.

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

Panells que estaven associats a aquesta cita abans de la cancel·lació. Consulta els detalls del panell (nom,
biomarcadors) a [Llista els panells](https://docs.anivahealth.com/ca/api/panels/list-panels.md).

**Camps d'associació del panell**

**panel\_id** `string`

UUID del panell — contrasta'l amb [Llista els panells](https://docs.anivahealth.com/ca/api/panels/list-panels.md).

**added\_at** `string`

Marca de temps ISO 8601 de quan es va associar el panell a aquesta cita per primera vegada.

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

Biomarcadors a la carta associats a aquesta cita fora de qualsevol panell (consulta [Afegeix biomarcadors
personalitzats](https://docs.anivahealth.com/ca/api/appointments/add-individual-biomarkers.md)). Contrasta cada `biomarker_id`
amb [Llista els biomarcadors](https://docs.anivahealth.com/ca/api/biomarkers/list-biomarkers.md) per obtenir les dades de visualització.

**Camps de biomarcadors individuals**

**biomarker\_id** `integer`

Identificador del biomarcador — contrasta'l amb
[Llista els biomarcadors](https://docs.anivahealth.com/ca/api/biomarkers/list-biomarkers.md).

**added\_at** `string`

Marca de temps ISO 8601 de quan es va associar el biomarcador a aquesta cita per primera vegada.

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

Enviaments que estaven vinculats a aquesta cita abans de la cancel·lació. Cada `id` es contrasta
amb [Obtén l'enviament](https://docs.anivahealth.com/ca/api/shipments/get-shipment.md).

**Camps de vinculació de l'enviament**

**id** `string`

Identificador de referència de l'enviament — contrasta'l amb
[Obtén l'enviament](https://docs.anivahealth.com/ca/api/shipments/get-shipment.md).

**added\_at** `string`

Marca de temps ISO 8601 de quan es va vincular l'enviament a aquesta cita per primera vegada.

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

Codis de laboratori (codis de barres dels tubs) registrats per a aquesta cita, per ordre d'escaneig. Buit fins que es confirmi l'extracció
de sang. Una extracció venosa porta un sol codi imprès a cada tub; una extracció capil·lar porta un
codi per microtub. Els resultats i documents a [Obtén els resultats](https://docs.anivahealth.com/ca/api/appointments/get-results.md) fan referència
a aquests codis mitjançant `lab_code`.

## Respostes d'error

| Estat | Descripció |
| - | - |
| `400` | Format d'ID no vàlid, o un cos mal format / `cancellation_reason` de més de 500 caràcters. |
| `403` | Prohibit — la teva clau d'API no té accés a aquesta operació o la cita queda fora del teu context d'accés. |
| `404` | No s'ha trobat la cita. |
| `409` | L'extracció de sang ja s'ha confirmat, o la cita ja s'ha cancel·lat amb un motiu diferent. |
| `500` | Error intern del servidor. |

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