VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Venddor Ads

POSTMudar status da campanha

Ativa, pausa, encerra ou devolve ao rascunho uma campanha do seller.

É a chave liga/desliga da campanha. Ao ativar, a plataforma emite o evento de campanha ativada (útil para integrações via webhook). A API não impõe uma ordem entre os status: qualquer um dos quatro pode ser aplicado a qualquer momento, inclusive reativar uma campanha ended.

POST/api/v1/vendor/ads/campaigns/{id}/statusSeller

Altera o status de uma campanha

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de caminho

iduuidobrigatório
Id da campanha.

Corpo da requisição

statusstringobrigatório
draftactivepausedended
Novo status.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/vendor/ads/campaigns/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/status" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "active"
}'
200Campanha atualizada
json
{
  "id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "name": "Chinelos de verão",
  "status": "active",
  "bid_cents": 80,
  "daily_budget_cents": 5000,
  "total_budget_cents": 50000,
  "spent_today_cents": 0,
  "spent_total_cents": 0,
  "product_ids": [
    "1c5e8a30-92b4-4d6f-8e21-5a7b9c0d3e44"
  ],
  "created_at": "2026-10-11T12:00:00Z",
  "updated_at": "2026-10-11T12:00:00Z"
}

Campos da resposta

...object
A campanha completa, como em Consultar campanhas.

Erros

StatusQuandoCorpo de exemplo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário autenticado não está vinculado a nenhum seller.{"error":"no vendor account associated with this user"}
400JSON inválido.{"error":"invalid request body","detail":"..."}
400status fora dos quatro valores.{"error":"failed to change status","detail":"invalid status: running"}
400Campanha inexistente ou de outro seller.{"error":"failed to change status","detail":"campaign not found"}
Ativar não garante veicular

Uma campanha active só participa do leilão com saldo maior que zero, orçamento do dia não esgotado, produto ativo e com estoque, seller ativo e Ads ligado pelo administrador. Confira a carteira quando uma campanha ativa não gerar cliques.

Veja também

  • Criar e alterar
  • Carteira
Anterior
Criar e alterar campanhas
Próxima
Carteira de mídia
Nesta página
  • Exemplo de requisição
  • Erros
  • Veja também