# Cancelar mensagem agendada

`DELETE /scheduler/{{id}}`

Pasta: **Scheduler**

## Autenticação

```http
token: {{token}}
```

## Descrição

# Cancelar mensagem agendada

Cancela um agendamento específico pelo ID. Use quando o lembrete não deve mais ser enviado.

## Endpoint

`DELETE {{baseUrl}}/scheduler/{{id}}`

## Autenticação

Envie o token da instância no header `token: {{token}}`.

## Parâmetros

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| `id` | string (path) | Sim | ID do agendamento (campo `message.id` na resposta de schedule/delay). |

## Exemplo de Requisição

```bash
curl --request DELETE '{{baseUrl}}/scheduler/{{id}}' \
  --header 'token: {{token}}'
```

## Resposta de Sucesso

```json
{
  "success": true
}
```

## Erros comuns

- `401 Unauthorized`: o header `token` não foi enviado ou é inválido.
- `500 Internal Server Error`: agendamento não encontrado ou falha ao cancelar.

## Observações

- O status no banco passa a `cancelled` e o item sai da fila em memória.
- Esta rota **não** exige modo mobile.

## cURL

```bash
curl -X DELETE "{{baseUrl}}/scheduler/{{id}}" \
  -H "token: {{token}}"
```

---

[Índice da pasta](./index.md) · [Índice geral](../index.md) · [UI](https://gozap.dev/docs?op=scheduler/cancelar-mensagem-agendada)