CLclicksign
executions

Cancela uma execução

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.

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

Path parameters

execution_idstring required

Execution ID

Response

OK

callback_urlstring

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.

contextobject

Objeto livre injetado no POST /execute. Persistido no HEAD e usado na interpolação de envelope/signatários, forms e consent.

created_atstring
execution_idstring
flow_idstring
presentation_runner_errorobject
status'running' | 'completed' | 'failed' | 'canceled'

running | completed | failed | canceled

updated_atstring
web_urlstring

Link da execução na experiência web da Clicksign. Presente somente quando channel="web".

whatsapp_conclusion_outboundobject
whatsapp_presentation_outboundobject

Example response

{
  "callback_url": "https://api.cliente.com/webhooks/clickflow",
  "channel": "whatsapp",
  "current_step": {
    "id": "3",
    "type": "signature",
    "url": "https://app.clicksign.com/notarial/widget/signatures/uuid/redirect"
  },
  "status": "running",
  "web_url": "https://app.clicksign.com/app/flow-public/uuid"
}

Changes

No recorded changes to this operation across all 1 revision of this API.