Skip to content

Atualizar Status da Tarefa ​

PATCH /external/v1/tasks/:id/status

Move uma tarefa para pending, in_progress ou completed. Concluir registra quem concluiu e quando; sair de completed reabre a tarefa.

Autenticação ​

Requer permissão tasks:write. A tarefa precisa estar visível para o usuário que criou a chave.

Parâmetros de Caminho ​

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

Corpo da Requisição ​

CampoTipoObrigatórioDescrição
statusstringSimpending, in_progress ou completed

Etapas de playbook e tarefas recorrentes

Concluir uma etapa de uma execução de playbook avança o progresso da execução; quando a última etapa é concluída, a execução passa a completed. Concluir uma tarefa recorrente cria a próxima ocorrência e devolve o id dela em next_occurrence_id. As etapas de uma execução cancelada não podem mudar de status, inclusive as etapas concluídas antes do cancelamento.

Requisição ​

bash
curl --request PATCH \
  --url "https://app.getraze.com/external/v1/tasks/7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11/status" \
  --header "Content-Type: application/json" \
  --header "X-API-Key: YOUR_API_KEY" \
  --data '{ "status": "in_progress" }'
javascript
const axios = require('axios');

const taskId = '7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11';

const response = await axios.patch(
  `https://app.getraze.com/external/v1/tasks/${taskId}/status`,
  { status: 'in_progress' },
  { headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);

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

task_id = '7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11'

response = requests.patch(
    f'https://app.getraze.com/external/v1/tasks/{task_id}/status',
    headers={'X-API-Key': 'YOUR_API_KEY'},
    json={'status': 'in_progress'}
)

print(response.json())

Resposta ​

json
{
  "success": true,
  "data": {
    "id": "7b1e4c52-9a0d-4f1e-8c35-2d6f0a9b3e11",
    "status": "in_progress",
    "is_completed": false
  },
  "changed": true,
  "next_occurrence_id": null
}

data é a tarefa completa (formato de Buscar Tarefa). changed é false quando a tarefa já tinha aquele status; nesse caso nada é gravado.

Erros ​

StatusCódigoDescrição
400VALIDATION_ERRORstatus ausente ou inválido, ou a tarefa é uma etapa de uma execução de playbook cancelada
404NOT_FOUNDTarefa não encontrada, ou não visível para o criador da chave

GetRaze - AI-Powered Lead Generation