Skip to content

Cancelar Execução de Playbook ​

POST /external/v1/playbook-runs/:id/cancel

Cancela uma execução em andamento. As etapas ainda não concluídas passam a cancelled e saem das listas de tarefas de todos; as etapas concluídas ficam como estão. Uma execução cancelada não pode ser retomada: inicie o playbook de novo, se precisar.

Autenticação ​

Requer permissão playbooks:run.

Parâmetros de Caminho ​

ParâmetroTipoObrigatórioDescrição
idstringSimIdentificador da execução (UUID)

Corpo da Requisição ​

CampoTipoObrigatórioDescrição
reasonstringNãoPor que a execução foi cancelada (máx. 1000 caracteres)

Requisição ​

bash
curl --request POST \
  --url "https://app.getraze.com/external/v1/playbook-runs/3ef8c1c3-c081-4187-a6aa-657fbf1a813b/cancel" \
  --header "Content-Type: application/json" \
  --header "X-API-Key: YOUR_API_KEY" \
  --data '{ "reason": "Negócio perdido" }'
javascript
const axios = require('axios');

const runId = '3ef8c1c3-c081-4187-a6aa-657fbf1a813b';

const response = await axios.post(
  `https://app.getraze.com/external/v1/playbook-runs/${runId}/cancel`,
  { reason: 'Negócio perdido' },
  { headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);

console.log(response.data);
python
import requests

run_id = '3ef8c1c3-c081-4187-a6aa-657fbf1a813b'

response = requests.post(
    f'https://app.getraze.com/external/v1/playbook-runs/{run_id}/cancel',
    headers={'X-API-Key': 'YOUR_API_KEY'},
    json={'reason': 'Negócio perdido'}
)

print(response.json())

Resposta ​

A execução, no formato de Buscar Execução de Playbook, com status: cancelled, cancelled_at e cancelled_reason.

Erros ​

StatusCódigoDescrição
404NOT_FOUNDExecução não encontrada nesta conta
409CONFLICTA execução não está em andamento (já concluída ou cancelada)

GetRaze - AI-Powered Lead Generation