Pausar, retomar ou reagendar

PATCH /campaigns

Controla uma campanha:

Fora disso, 409.

Autenticação

[
  {
    "token": []
  }
]

{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}

Corpo da requisição

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "minProperties": 2,
        "properties": {
          "campaign_id": {
            "type": "string",
            "description": "O `id` da campanha."
          },
          "status": {
            "type": "string",
            "enum": [
              "paused",
              "scheduled",
              "sending"
            ],
            "description": "`paused` pausa; `scheduled` retoma uma pausada; `sending` manda agora uma agendada."
          },
          "scheduled_at": {
            "type": "string",
            "format": "date-time",
            "description": "Novo horário de início, só para campanha agendada (`scheduled`). As mensagens que faltam mudam junto. Até 365 dias à frente; com arquivo em base64 (ou a URL de `/files/uploads/` devolvida pela API) em alguma mensagem, até 30 dias. Para mais longe, mande o arquivo por uma URL pública."
          }
        },
        "required": [
          "campaign_id"
        ]
      },
      "example": {
        "campaign_id": "r7f3a9c2e1b4d5f",
        "status": "paused"
      }
    }
  }
}

Respostas

{
  "200": {
    "description": "A campanha.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Campaign"
        },
        "example": {
          "id": "r7f3a9c2e1b4d5f",
          "name": "Black Friday",
          "status": "paused",
          "scheduled_at": "2026-11-27T12:00:00.000Z",
          "delay_min_seconds": 10,
          "delay_max_seconds": 30,
          "total": 500,
          "sent": 320,
          "delivered": 140,
          "read": 180,
          "played": 0,
          "failed": 4,
          "created_at": "2026-11-26T18:00:00.000Z",
          "updated_at": "2026-11-27T12:40:00.000Z"
        }
      }
    }
  },
  "401": {
    "description": "Token inválido ou ausente.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unauthorized",
          "message": "Token inválido."
        }
      }
    }
  },
  "404": {
    "description": "Campanha não encontrada.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "not_found",
          "message": "Campanha não encontrada."
        }
      }
    }
  },
  "409": {
    "description": "A ação não vale no estado atual: retomar uma campanha que não está pausada, ou reagendar uma que não está agendada, ou mandar agora uma que não está agendada nem pausada.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "conflict",
          "message": "Campanha concluída."
        }
      }
    }
  },
  "429": {
    "$ref": "#/components/responses/RateLimited"
  },
  "500": {
    "$ref": "#/components/responses/InternalError"
  },
  "501": {
    "$ref": "#/components/responses/CloudUnsupported"
  }
}

Estado: Disponível

Compatibilidade de canais

Eventos que esta rota gera

O que chega no seu webhook (ou em GET /events) depois desta rota.

campaign.updated: o estado novo

{
  "id": "evt_01JAB3K9ZQ7V0M4T8R2X6WYD5H",
  "type": "campaign.updated",
  "created_at": "2026-10-17T12:00:00.000Z",
  "inbox": {
    "id": "r0269625d29bfbd",
    "name": "loja",
    "phone": "5511888888888",
    "channel": "whatsapp_web"
  },
  "data": {
    "id": "r7f3a9c2e1b4d5f",
    "status": "paused",
    "total": 500,
    "name": "Promoção de outubro",
    "sent": 120,
    "failed": 0,
    "updated_at": "2026-10-17T12:00:00.000Z"
  }
}

Antes e depois (uazapi → Orkesio)

Na uazapi: POST /sender/edit.

• folder_id → campaign_id; as ações viram campos: stop → status: paused, continue → status: scheduled, send_now → status: sending, reschedule → scheduled_at (data ISO); delete → DELETE /campaigns/{campaign_id}.
• Responde a campanha (antes status, message, scheduled_for e messages_updated).

#/components/schemas/Campaign

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "status"
  ],
  "description": "Campanha (envio em massa). Cada mensagem conta em um só entre `delivered`, `read` e `played`; `sent` é o total que saiu, e já inclui esses três. Entregues no total = `delivered` + `read` + `played`.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Id da campanha (o `campaign_id` das mensagens)."
    },
    "name": {
      "type": "string",
      "description": "Nome da campanha."
    },
    "status": {
      "type": "string",
      "enum": [
        "scheduled",
        "sending",
        "paused",
        "done"
      ],
      "description": "`scheduled` (esperando a hora), `sending`, `paused` ou `done`. A campanha também se pausa sozinha quando o WhatsApp restringe a conta de iniciar conversas (`account_restricted` ou `new_chat_limit`): a mensagem recusada volta a agendada, sai o `campaign.updated` e o motivo (com até quando) está em `GET /inbox/limits`. Retomar é com `PATCH /campaigns` (`status: scheduled`); enquanto a restrição durar, ela se pausa de novo."
    },
    "scheduled_at": {
      "type": "string",
      "format": "date-time",
      "description": "Quando começa. ISO 8601 em UTC com milissegundos."
    },
    "delay_min_seconds": {
      "type": "integer",
      "description": "Intervalo mínimo entre mensagens, em segundos."
    },
    "delay_max_seconds": {
      "type": "integer",
      "description": "Intervalo máximo entre mensagens, em segundos."
    },
    "total": {
      "type": "integer",
      "description": "Mensagens na campanha."
    },
    "sent": {
      "type": "integer",
      "description": "Saíram com sucesso (`delivered`, `read` e `played` já estão aqui dentro)."
    },
    "delivered": {
      "type": "integer",
      "description": "Entregues e ainda não lidas."
    },
    "read": {
      "type": "integer",
      "description": "Lidas (as ouvidas ou vistas contam em `played`)."
    },
    "played": {
      "type": "integer",
      "description": "Ouvidas ou vistas (áudio e vídeo)."
    },
    "failed": {
      "type": "integer",
      "description": "Falharam."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Criação. ISO 8601 em UTC com milissegundos."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Última alteração. ISO 8601 em UTC com milissegundos."
    }
  }
}

#/components/schemas/OrkesioError

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
    },
    "message": {
      "type": "string",
      "description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
    },
    "field": {
      "type": "string",
      "description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
    }
  },
  "required": [
    "error",
    "message"
  ],
  "additionalProperties": true,
  "description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}

#/components/responses/RateLimited

{
  "description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
  "headers": {
    "Retry-After": {
      "description": "Segundos até poder chamar de novo.",
      "schema": {
        "type": "integer",
        "minimum": 1
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "rate_limited",
        "message": "Muitas requisições."
      }
    }
  }
}

#/components/responses/InternalError

{
  "description": "`internal_error`: falha inesperada na api (no banco, por exemplo); tente de novo.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "internal_error",
        "message": "Falha inesperada."
      }
    }
  }
}

#/components/responses/CloudUnsupported

{
  "description": "`unsupported_for_channel`: o canal da inbox não atende esta rota (rota só do WhatsApp Web numa inbox oficial, ou rota da API oficial numa inbox do WhatsApp Web). O canal está em `Inbox.channel`.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "unsupported_for_channel",
        "message": "Esta rota não está disponível no canal da inbox."
      }
    }
  }
}

Guias relacionados

Visão geral · O que funciona em cada canal · O que muda da uazapi