Actions34
- Cliente Actions
- Catálogo Actions
- Pedido Actions
- Conversa Actions
- Contexto Actions
- Telemetria Actions
- Canal WhatsApp Actions
- Paciente Actions
- Procedimento Actions
- Agenda Actions
- Agendamento Actions
- Lembrete Odonto Actions
Agendamento → Cancelar
AI-generatedSummary
Cancel an existing 'Agendamento' (appointment) in the Núcleo Wondai system by providing administrative proof and optional cancellation reason.
Inputs
- Token ID Dinamico — Optional dynamic Token ID returned by multi-tenant bootstrap; must be used with dynamic Signing Secret.
- Signing Secret Dinamico — Optional ephemeral Signing Secret from bootstrap; do not log or expose this value.
- Telefone Oficial do Canal (required) — Official channel phone number, obtained from authenticated channel envelope; must not come from $fromAI.
- Nome do Paciente (required) — Name provided by the contact to identify the correct patient.
- Token do Agendamento (required) — Pre-LLM redacted scheduling token; use a fixed secure branch expression, never $fromAI.
- Agendamento ID (required) — UUID of the appointment obtained by an authorized query in the same deterministic branch.
- Motivo — Optional reason for cancellation.
- Idempotency Key — Use the same key (e.g., WhatsApp message ID) on retries to prevent duplicate cancellation requests.
Output shape
a single JSON object representing the cancellation response from the Núcleo API
Includes HTTP status code and JSON payload; if the cancellation fails and continueOnFail is enabled, returns an error object per item. The operation is idempotent when the same Idempotency Key is reused.
Examples
Example 1: Cancel an appointment with required proof fields and optional reason
Set Resource to 'Agendamento', Operation to 'Cancelar', and provide all required proof fields (Telefone Oficial do Canal, Nome do Paciente, Token do Agendamento, Agendamento ID). Optionally provide Motivo and Idempotency Key to ensure idempotency.