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

# Agendar uma marcação

> Guia passo a passo: encontrar um local de análises, verificar a disponibilidade e agendar uma marcação de colheita de sangue com a API da Aniva.

Usa este guia para encontrar um local de teste, criar uma marcação para um perfil de paciente e associar os painéis de análise a realizar. Conclui estes passos antes de o paciente chegar para a colheita de sangue.

**1. Explorar locais disponíveis**

Obtém a lista de locais de teste disponíveis na tua conta enviando um pedido `GET` para `/api/v1/locations`.

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/locations \
  --header 'x-api-key: YOUR_API_KEY'
```

```javascript JavaScript theme={null}
const response = await fetch('https://anivahealth.com/api/v1/locations', {
  headers: {
    'x-api-key': 'YOUR_API_KEY',
  },
});

const locations = await response.json();
```

A resposta é um array de objetos de local:

```json theme={null}
[
  {
    "id": "b7e2d914-1c3a-4f08-9e5b-6d0f7a83c421",
    "name": "Aniva Berlin Mitte",
    "company_name": "Aniva GmbH",
    "street": "Friedrichstraße",
    "house_number": "112",
    "address_line_2": null,
    "city": "Berlin",
    "state": "Berlin",
    "postal_code": "10117",
    "country_name": "Germany",
    "country_code": "DE",
    "timezone": "Europe/Berlin",
    "contact_phone": "+4930987654321",
    "email": "berlin-mitte@anivahealth.com",
    "website": "https://anivahealth.com",
    "google_maps_url": null,
    "image_url": null,
    "open_hours": {
      "monday": [{ "open": "08:00", "close": "17:00" }],
      "tuesday": [{ "open": "08:00", "close": "17:00" }],
      "wednesday": [{ "open": "08:00", "close": "17:00" }],
      "thursday": [{ "open": "08:00", "close": "17:00" }],
      "friday": [{ "open": "08:00", "close": "15:00" }],
      "saturday": [],
      "sunday": []
    }
  }
]
```

> [!TIP]
>
> Usa o campo `timezone` do objeto de local ao construir o timestamp de `scheduled_at`. Converter a hora da marcação para o fuso horário do local ajuda-te a evitar agendar fora do horário de funcionamento.

> [!WARNING]
>
> Não deduzas horários disponíveis apenas a partir de `open_hours`. Chama [Obter disponibilidade](https://docs.anivahealth.com/pt/api/locations/get-availability.md) e agenda uma das horas de início devolvidas — essa grelha também tem em conta marcações existentes, exceções por data e a antecedência mínima.

**2. Criar a marcação**

Envia um pedido `POST` para `/api/v1/appointments` com o ID do perfil, o ID do local e a hora pretendida para a marcação. A hora tem de corresponder a uma hora de início devolvida por [Obter disponibilidade](https://docs.anivahealth.com/pt/api/locations/get-availability.md).

> [!NOTE]
>
> `scheduled_at` tem de ser uma data e hora futura no formato ISO 8601, por exemplo `2026-05-12T07:30:00Z`. Timestamps no passado são rejeitados com um erro `400`, assim como horários dentro da [antecedência mínima de 12 horas](https://docs.anivahealth.com/pt/api/appointments/create-appointment.md#antecedencia-minima) em locais geridos pela Aniva.

> [!TIP]
>
> Repetir este pedido é seguro. Um perfil só pode ter uma marcação por local e hora, pelo que um pedido de criação reenviado ou duplicado devolve `409` com o `appointment_id` existente em vez de criar duas marcações para o paciente.

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/appointments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
    "profile_id": "a3f1c2e4-58b7-4d9e-b012-3c7f8a2e1d56",
    "location_id": "b7e2d914-1c3a-4f08-9e5b-6d0f7a83c421",
    "scheduled_at": "2026-05-12T07:30:00Z"
  }'
```

```javascript JavaScript theme={null}
const response = await fetch('https://anivahealth.com/api/v1/appointments', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'YOUR_API_KEY',
  },
  body: JSON.stringify({
    profile_id: 'a3f1c2e4-58b7-4d9e-b012-3c7f8a2e1d56',
    location_id: 'b7e2d914-1c3a-4f08-9e5b-6d0f7a83c421',
    scheduled_at: '2026-05-12T07:30:00Z',
  }),
});

const appointment = await response.json();
```

Um pedido bem-sucedido devolve `201 Created` com o objeto da marcação:

```json theme={null}
{
  "id": "c9d4e827-3b6f-4a1c-8d2e-5f0b9c7e3a12",
  "profile_id": "a3f1c2e4-58b7-4d9e-b012-3c7f8a2e1d56",
  "location_id": "b7e2d914-1c3a-4f08-9e5b-6d0f7a83c421",
  "scheduled_at": "2026-05-12T07:30:00Z",
  "status": "confirmed",
  "cancellation_reason": null,
  "results_ready_emails": [],
  "created_at": "2026-04-01T11:02:47Z",
  "updated_at": null,
  "profile": {
    "id": "a3f1c2e4-58b7-4d9e-b012-3c7f8a2e1d56",
    "handle": null,
    "first_name": "Emma",
    "last_name": "Müller",
    "email": "emma.muller@example.com",
    "phone": null,
    "sex": 2,
    "date_of_birth": "1990-04-15",
    "height": null,
    "weight": null,
    "language": "de",
    "transactional_emails_enabled": null,
    "created_at": "2026-04-01T09:14:22Z",
    "updated_at": null
  },
  "panels": [],
  "individual_biomarkers": [],
  "shipments": [],
  "lab_codes": []
}
```

Guarda o `id` da marcação — vais precisar dele para adicionar painéis e confirmar a colheita de sangue.

**3. Adicionar painéis de análise**

Associa os painéis de análise que queres realizar na amostra de sangue enviando um pedido `POST` para `/api/v1/appointments/{id}/panels`.

Os IDs dos painéis são UUIDs. Chama [Listar painéis](https://docs.anivahealth.com/pt/api/panels/list-panels.md) para obter os painéis que a tua chave API pode pedir.

> [!WARNING]
>
> Não é possível adicionar painéis depois de a colheita de sangue ser confirmada. Adiciona todos os painéis necessários antes da confirmação — consulta [Confirmar colheita de sangue](https://docs.anivahealth.com/pt/guides/confirm-blood-draw.md) para mais detalhes.

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/appointments/c9d4e827-3b6f-4a1c-8d2e-5f0b9c7e3a12/panels \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
    "panel_ids": [
      "d1f5a302-7c8e-4b2d-9f1a-0e3c6d4b8a27",
      "e2a7b491-5d9f-4c3e-8a2b-1f4d7e5c9b38"
    ]
  }'
```

```javascript JavaScript theme={null}
const response = await fetch(
  'https://anivahealth.com/api/v1/appointments/c9d4e827-3b6f-4a1c-8d2e-5f0b9c7e3a12/panels',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': 'YOUR_API_KEY',
    },
    body: JSON.stringify({
      panel_ids: [
        'd1f5a302-7c8e-4b2d-9f1a-0e3c6d4b8a27',
        'e2a7b491-5d9f-4c3e-8a2b-1f4d7e5c9b38',
      ],
    }),
  }
);

const result = await response.json();
```

Um pedido bem-sucedido devolve `200 OK`, confirmando que os painéis foram adicionados:

```json theme={null}
{
  "success": true
}
```

## Reagendar ou cancelar

Depois de criares uma marcação, ainda a podes modificar antes de a colheita de sangue ser confirmada:

* **Reagendar ou alterar o local** — Envia um pedido `PATCH` para `/api/v1/appointments/{id}` com os campos a atualizar. Consulta [Atualizar marcação](https://docs.anivahealth.com/pt/api/appointments/update-appointment.md).
* **Cancelar** — Envia um pedido `DELETE` para `/api/v1/appointments/{id}`. Consulta [Cancelar marcação](https://docs.anivahealth.com/pt/api/appointments/cancel-appointment.md).

> [!NOTE]
>
> Ambas as operações só estão disponíveis antes da colheita de sangue — ou seja, enquanto a
> marcação estiver no estado `pending` ou `confirmed`. Assim que a marcação passar para
> `blood_drawn`, não são possíveis mais modificações.

## Tratamento de erros

| Estado | Causa | Resolução |
| - | - | - |
| `400 Bad Request` | Falta um campo obrigatório, `scheduled_at` está no passado, fora da grelha de horários ou dentro da antecedência mínima de 12 horas, ou `panel_ids` está vazio. | Consulta o corpo do erro para ver a mensagem de validação e corrige o pedido. Para a antecedência mínima, escolhe um horário mais tarde em [Obter disponibilidade](https://docs.anivahealth.com/pt/api/locations/get-availability.md). |
| `403 Forbidden` | A tua chave API não tem acesso a esta operação. | Contacta a Aniva para confirmar as permissões da tua chave API. |
| `404 Not Found` | O `profile_id` ou `location_id` não existe, ou o ID da marcação é inválido ao adicionar painéis. | Verifica se os IDs estão corretos e pertencem à tua conta. |
| `409 Conflict` | Tentaste adicionar painéis ou modificar uma marcação que já está em `blood_drawn` ou `cancelled`. | Não são possíveis mais alterações após a confirmação. |
| `409 Conflict` | Este perfil já tem uma marcação nesse local e hora, ou o horário atingiu a capacidade máxima. | O caso duplicado inclui o `appointment_id` existente — usa essa marcação em vez de tentar novamente. Caso contrário, escolhe outro horário. |


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