---
title: "Cancela uma execução"
method: POST
path: "/api/v1/executions/{execution_id}/cancel"
tags: ["executions"]
---

# Cancela uma execução

`POST /api/v1/executions/{execution_id}/cancel`

## Request

- Base URL: `https://clickflow-runner-sandbox.clicksign.com`
- URL: `https://clickflow-runner-sandbox.clicksign.com/api/v1/executions/{execution_id}/cancel`
- Auth: API key in header `Authorization`

Solicita ao orquestrador o cancelamento da execução (execution_id canônico). Idempotente: repetir o cancelamento sobre uma execução já cancelada não altera o estado nem gera novo evento de auditoria, e devolve 200 novamente. Execução já em outro estado terminal (completed/failed) responde 409. A etapa que estava em andamento também passa a canceled. No canal whatsapp, se essa etapa era form, verify ou kyc, o contato recebe a mesma mensagem de falha da etapa. Nos canais api e web, nada é enviado.

## Path parameters

- `execution_id` string, required

## Response `200`

OK

- object
  - `account` object
    - `id` integer
    - `key` string
    - `name` string
  - `callback_url` string: URL de callback informada no disparo, devolvida para conferência. Ausente quando o disparo não informou callback_url.
  - `channel` 'whatsapp' | 'api' | 'web': Canal definido no POST /execute. "whatsapp": Runner gerencia envio de mensagens. "api": o integrador entrega os links. "web": a Clicksign entrega a jornada pelo link web da execução.
  - `contact` object
    - `person_birthday` string
    - `person_documentation` string
    - `person_email` string: E-mail opcional da pessoa da execução. Quando preenchido, o Executor repassa o valor à etapa de Assinatura.
    - `person_name` string
    - `phone_number` string
  - `context` object: Objeto livre injetado no POST /execute. Persistido no HEAD e usado na interpolação de envelope/signatários, forms e consent.
  - `created_at` string
  - `current_step` object: Passo em andamento. Presente somente quando channel="api" ou "web" e há step RUNNING. Permite ao cliente saber qual URL entregar ao contato sem precisar consultar os steps.
    - `id` string: ID do step no orquestrador
    - `type` 'form' | 'verify' | 'signature' | 'embedded_signature' | 'acceptance': Tipo do step: form | verify | signature | embedded_signature | acceptance
    - `url` string, nullable: Link para o contato acessar. null para acceptance.
  - `execution_id` string
  - `files` object[]: Arquivos enviados em base64 no disparo (files[]), já materializados no bucket próprio do Runner — expõe só a key de correlação e uma URL temporária de leitura, nunca bucket/S3 key internos nem o conteúdo.
    - `error` string: Error vem preenchido (mensagem genérica, sem detalhe interno) quando o presign desse arquivo falha — o cliente sabe distinguir "sem URL por erro transitório" de um eventual item sem URL por outro motivo, em vez de silêncio.
    - `key` string
    - `url` string
  - `flow_id` string
  - `presentation_runner_error` object
  - `status` 'running' | 'completed' | 'failed' | 'canceled': running | completed | failed | canceled
  - `updated_at` string
  - `web_url` string: Link da execução na experiência web da Clicksign. Presente somente quando channel="web".
  - `whatsapp_conclusion_outbound` object
  - `whatsapp_presentation_outbound` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `409`: Conflict
- `500`: Internal Server Error

---

[API](https://skmtc.dev/clicksign/apis/clickflow-runner-api.md) - [All operations](https://skmtc.dev/clicksign/apis/clickflow-runner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clicksign/apis/clickflow-runner-api/revisions/f5ee0b7db692?raw)