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

# Cancelar marcação

> Cancelar uma marcação de colheita de sangue

Cancela uma marcação definindo o seu estado como `cancelled`. Só podem ser canceladas marcações cuja colheita de sangue ainda não tenha sido confirmada.

Cancelar uma marcação que já está como `cancelled` devolve `200` com essa marcação e não escreve nada — não é registado um segundo cancelamento. A resposta inclui `Idempotent-Replayed: true` para que possas distinguir uma repetição da chamada que realizou a ação. Uma repetição que inclua um `cancellation_reason` **diferente** devolve `409` em vez disso: o motivo registado nunca é substituído. Consulta [Idempotência](https://docs.anivahealth.com/pt/concepts/idempotency.md).

> [!WARNING]
>
> Não é possível cancelar marcações após a confirmação da colheita de sangue — isso devolve `409
>     Conflict`.

Requer o âmbito `appointments_schedule` ou `appointments_manage`.

## Pedido

### Parâmetros de caminho

**id** `string` *required*

Identificador único (UUID) da marcação a cancelar.

### Parâmetros do corpo

O corpo é opcional — não envies qualquer corpo para cancelar sem registar um motivo.

**cancellation\_reason** `string`

Motivo de cancelamento em texto livre, até 500 caracteres (p. ex., `Patient no-show`). Guardado na
marcação e devolvido como `cancellation_reason` nesta e em leituras posteriores.

## Resposta

Em caso de sucesso, a API devolve `200 OK` com a marcação cancelada e o respetivo perfil incorporado.

**id** `string` *required*

Identificador único da marcação (UUID).

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

UUID do perfil a que pertence esta marcação.

**location\_id** `string`

UUID do local de teste onde decorre a colheita de sangue.

**scheduled\_at** `string`

Data e hora agendada da marcação como instante UTC (ISO 8601 com sufixo `Z`, p. ex.,
`2026-05-15T10:30:00Z`). Pode ser `null`.

**status** `string` *required*

Estado da marcação. Será `cancelled` após um cancelamento bem-sucedido.

**cancellation\_reason** `string`

Motivo em texto livre registado quando a marcação foi cancelada (p. ex., falta de comparência, cancelamento tardio,
'Falhou. Repetição necessária'). `null`, exceto quando `status` é `cancelled`.

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

Endereços que recebem um e-mail assim que todos os resultados laboratoriais forem definitivos, em minúsculas. Vazio quando desativado. Consulta
[E-mails de resultados prontos](https://docs.anivahealth.com/pt/concepts/results.md#e-mails-de-resultados-prontos).

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

Como o sangue é colhido: `capillary` (ponta do dedo ou parte superior do braço, em microtubos) ou `venous` (na veia,
em tubos). É o método definido na marcação ou, caso contrário, o `default_draw_method` do respetivo
[local](https://docs.anivahealth.com/pt/concepts/locations.md). Após a colheita de sangue, é o método que foi utilizado.

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

Data e hora ISO 8601 da criação da marcação.

**updated\_at** `string`

Data e hora ISO 8601 da última atualização. Pode ser `null`.

**profile** `object` *required*

O perfil do paciente associado a esta marcação.

**perfil**

**id** `string`

Identificador único do perfil (UUID).

**handle** `string`

Handle ou nome de utilizador do perfil. Pode ser `null`.

**first\_name** `string`

Nome próprio. Pode ser `null`.

**last\_name** `string`

Apelido. Pode ser `null`.

**email** `string`

Endereço de e-mail. Pode ser `null`.

**phone** `string`

Número de telefone no formato E.164. Pode ser `null`.

**sex** `integer`

Sexo biológico segundo a norma ISO/IEC 5218. Pode ser `null`.

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

Data de nascimento no formato `YYYY-MM-DD`. Pode ser `null`.

**height** `number`

Altura em centímetros. Pode ser `null`.

**weight** `number`

Peso em quilogramas. Pode ser `null`.

**language** `string`

Idioma preferido: um dos 32 códigos em [Criar perfil](https://docs.anivahealth.com/pt/api/profiles/create-profile.md).

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

Se este perfil recebe e-mails transacionais (programáticos). Pode ser `null`.

**created\_at** `string`

Data e hora ISO 8601 da criação do perfil.

**updated\_at** `string`

Data e hora ISO 8601 da última atualização do perfil. Pode ser `null`.

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

Painéis que estavam associados a esta marcação antes do cancelamento. Consulta os detalhes do painel (nome,
biomarcadores) através de [Listar painéis](https://docs.anivahealth.com/pt/api/panels/list-panels.md).

**Campos de associação de painel**

**panel\_id** `string`

UUID do painel — cruza com [Listar painéis](https://docs.anivahealth.com/pt/api/panels/list-panels.md).

**added\_at** `string`

Data e hora ISO 8601 em que o painel foi associado pela primeira vez a esta marcação.

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

Biomarcadores avulsos associados a esta marcação fora de qualquer painel (consulta [Adicionar biomarcadores
personalizados](https://docs.anivahealth.com/pt/api/appointments/add-individual-biomarkers.md)). Cruza cada `biomarker_id`
com [Listar biomarcadores](https://docs.anivahealth.com/pt/api/biomarkers/list-biomarkers.md) para obter os dados de apresentação.

**Campos de biomarcador individual**

**biomarker\_id** `integer`

Identificador do biomarcador — cruza com
[Listar biomarcadores](https://docs.anivahealth.com/pt/api/biomarkers/list-biomarkers.md).

**added\_at** `string`

Data e hora ISO 8601 em que o biomarcador foi associado pela primeira vez a esta marcação.

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

Envios que estavam associados a esta marcação antes do cancelamento. Cada `id` relaciona-se
com [Obter envio](https://docs.anivahealth.com/pt/api/shipments/get-shipment.md).

**Campos de associação de envio**

**id** `string`

Identificador de referência do envio — cruza com
[Obter envio](https://docs.anivahealth.com/pt/api/shipments/get-shipment.md).

**added\_at** `string`

Data e hora ISO 8601 em que o envio foi associado pela primeira vez a esta marcação.

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

Códigos de laboratório (códigos de barras dos tubos) registados para esta marcação, por ordem de leitura. Vazio até a colheita de sangue
ser confirmada. Uma colheita venosa tem um código impresso em todos os tubos; uma colheita capilar tem um
código por microtubo. Os resultados e documentos em [Obter resultados](https://docs.anivahealth.com/pt/api/appointments/get-results.md) referenciam
estes códigos através de `lab_code`.

## Respostas de erro

| Estado | Descrição |
| - | - |
| `400` | Formato de ID inválido, ou corpo malformado / `cancellation_reason` com mais de 500 caracteres. |
| `403` | Proibido — a tua chave de API não tem acesso a esta operação ou a marcação está fora do teu contexto de acesso. |
| `404` | Marcação não encontrada. |
| `409` | A colheita de sangue já foi confirmada ou a marcação já está cancelada com um motivo diferente. |
| `500` | Erro interno do 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.