Todos os produtos
Search
Central de documentação

Qoder CN Series:Pause a schedule

Última atualização: Jul 15, 2026

Pause um Forward Schedule ativo.

Cabeçalhos da requisição

Cabeçalho

Obrigatório

Descrição

Authorization

Sim

Bearer <PAT>

Content-Type

Não

application/json se houver corpo na requisição.

Idempotency-Key

Não

Chave de idempotência opcional para requisições não seguras.

Parâmetros de caminho

Parâmetro

Tipo

Obrigatório

Descrição

schedule_id

string

Sim

ID do Forward Schedule.

Exemplo de requisição

curl -s -X POST 'https://api.qoder.com.cn/api/v1/forward/schedules/sched_019f00112233445566778899aabbccdd/pause' \
  -H "Authorization: Bearer $QODER_PAT"

Exemplo de resposta

HTTP 200 OK

{
  "id": "sched_019f00112233445566778899aabbccdd",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_support",
  "name": "Daily tech brief",
  "status": "paused",
  "paused_reason": {
    "type": "manual"
  },
  "archived_at": null,
  "updated_at": "2026-06-22T12:00:00Z"
}

Campos da resposta

Retorna o objeto Schedule atualizado com status=paused.

Erros

HTTP

Tipo

Código

Gatilho

401

authentication_error

authentication_required

PAT inválido ou expirado.

404

not_found_error

schedule_not_found

Agendamento inexistente.

409

invalid_request_error

schedule_archived

Agendamento arquivado.

Observações

  • O corpo da requisição é opcional e pode ser um objeto JSON vazio {}.

  • Atualmente, apenas motivos de pausa manual estão disponíveis.