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

# Atualizar marcação

> Alterar os detalhes da marcação antes da colheita de sangue

Atualiza detalhes da marcação, como a hora agendada ou o local da análise. Apenas marcações cuja colheita de sangue ainda não tenha sido confirmada podem ser modificadas.

> [!WARNING]
>
> As marcações não podem ser modificadas depois de a colheita de sangue ter sido confirmada ou se já
> estiverem canceladas. Tentar atualizar uma marcação nesse estado devolve `409 Conflict`. A única
> exceção é `results_ready_emails`, que ainda podes alterar após a colheita de sangue.

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

## Pedido

### Parâmetros de caminho

**id** `string` *required*

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

### Parâmetros do corpo

Todos os parâmetros do corpo são opcionais — inclui apenas os campos que queres alterar.

**scheduled\_at** `string`

Nova data e hora da marcação no formato ISO 8601 (por exemplo, `2026-05-20T14:00:00Z` ou
`2026-05-20T16:00:00+02:00`). **Tem de incluir um designador de fuso horário** — `Z` ou um desvio
explícito como `+02:00`; datas e horas sem fuso horário são rejeitadas. Tem de estar no futuro.

Tem de ser o início exato de um horário com capacidade disponível — consulta
[Obter disponibilidade](https://docs.anivahealth.com/pt/api/locations/get-availability.md). A marcação a ser reagendada nunca conta
para a capacidade do seu próprio horário de destino, mas movê-la para um horário onde o mesmo perfil
já tem uma marcação *diferente* devolve `409` com o `appointment_id` dessa marcação.

Se o local *de destino* for operado pela Aniva, a nova hora também tem de ter pelo menos 12 horas de
antecedência — consulta [Antecedência mínima](https://docs.anivahealth.com/pt/api/appointments/create-appointment.md#antecedencia-minima).

**location\_id** `string`

UUID do novo local da análise. O local tem de existir e estar ativo. Usa [Listar
locais](https://docs.anivahealth.com/pt/api/locations/list-locations.md) para encontrares os IDs dos locais disponíveis.

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

Substitui a lista de até 5 endereços que recebem um email cada assim que todos os resultados
laboratoriais forem definitivos. Envia `[]` para desativares os emails. Este campo continua
editável após a colheita de sangue; apenas uma marcação cancelada o recusa. Após a colheita de
sangue, envia-o sozinho: com `scheduled_at` ou `location_id` no mesmo corpo, o pedido devolve
`409`. A tua chave precisa de acesso `results_view` ao paciente; caso contrário, `403`. Consulta
[Emails de resultados prontos](https://docs.anivahealth.com/pt/concepts/results.md#e-mails-de-resultados-prontos).

**draw\_method** `string | null`

Novo método de colheita: `capillary` ou `venous`, ou `null` para voltar a usar o
`default_draw_method` do local. O local tem de listar o método nos seus `draw_methods` e as
análises marcadas têm de ser possíveis com ele; caso contrário, `400`. Quando moves uma marcação
para outro local, a mesma verificação é executada lá: sobre o seu próprio `draw_method` ou, caso
contrário, sobre o `default_draw_method` do novo local.

## Resposta

Em caso de sucesso, a API devolve `200 OK` com a marcação atualizada 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 agendadas da marcação como instante UTC (ISO 8601 com sufixo `Z`, por exemplo,
`2026-05-20T14:00:00Z`). Pode ser `null`.

**status** `string` *required*

Estado atual da marcação. Um de `pending`, `confirmed`, `blood_drawn` ou `cancelled`. O detalhe
sobre a conclusão dos resultados laboratoriais obtém-se em
[Obter resultados](https://docs.anivahealth.com/pt/api/appointments/get-results.md); a progressão detalhada dos envios obtém-se a
partir de cada entrada no array `shipments` incorporado (vê abaixo) seguindo para
[Obter envio](https://docs.anivahealth.com/pt/api/shipments/get-shipment.md).

**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 atualmente associados a esta marcação. Exclui associações canceladas. 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 associados a esta marcação, com a associação mais antiga primeiro. Array vazio quando não
existem envios associados. Cruza cada `id` com [Obter envio](https://docs.anivahealth.com/pt/api/shipments/get-shipment.md) para
obteres o payload completo do envio.

**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` | Erro de validação — por ex., `scheduled_at` está no passado, é a menos de 12 horas num local gerido pela Aniva, formato de UUID inválido, o local não tem recipientes para o `draw_method` ou as análises marcadas não são possíveis com o `draw_method`. |
| `403` | Proibido — a tua chave de API não tem acesso a esta operação, a marcação ou o local estão fora do teu contexto de acesso, ou `results_ready_emails` está definido sem acesso `results_view` ao paciente. |
| `404` | Marcação ou local não encontrados. |
| `409` | A marcação não pode ser alterada (colheita de sangue já confirmada ou marcação cancelada), o horário pretendido atingiu a capacidade máxima, o local está fechado nessa data ou este perfil já tem outra marcação no local e horário pretendidos (inclui `appointment_id`). |
| `500` | Erro interno do servidor. |

```bash cURL theme={null}
curl --request PATCH \
  --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 '{
    "scheduled_at": "2026-05-20T14:00:00Z",
    "location_id": "d8f3e1a2-4c5b-6d7e-8f9a-0b1c2d3e4f5a"
  }'
```

```json 200 theme={null}
{
  "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "location_id": "d8f3e1a2-4c5b-6d7e-8f9a-0b1c2d3e4f5a",
  "scheduled_at": "2026-05-20T14:00:00Z",
  "status": "confirmed",
  "cancellation_reason": null,
  "results_ready_emails": [],
  "draw_method": "venous",
  "created_at": "2026-04-01T09:45:00Z",
  "updated_at": "2026-04-10T11:30: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": "Appointment cannot be modified after blood draw has been confirmed"
}
```

```json 404 theme={null}
{
  "error": "Location not found or inactive"
}
```


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