GET/v1/campaigns/{id}

Obter campanha

Devolve a campanha com conteúdo, variantes e métricas de envio.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenchaveSecretaoptional

Stored only in this browser for the chaveSecreta security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · integerrequired

ID da campanha, o id devolvido ao criar.

Responses

200application/json

A campanha.

{
  "id": 1287,
  "name": "Frete grátis só hoje",
  "status": "sent",
  "type": "instant",
  "category": "promo",
  "segment_id": 42,
  "segment_name": "Clientes VIP",
  "scheduled_at": null,
  "sent_at": "2026-10-06T15:20:40+00:00",
  "send_in_user_tz": false,
  "breaking": false,
  "recurrence": "none",
  "content": {
    "title": "Frete grátis só hoje",
    "body": "Em todo o site, para compras acima de R$ 99.",
    "url": "https://loja.exemplo.com.br/promo",
    "icon_url": "https://loja.exemplo.com.br/icone.png",
    "image_url": null,
    "buttons": [
      {
        "title": "Ver ofertas",
        "action": "ver-ofertas"
      }
    ]
  },
  "ab_test": false,
  "test_fraction": null,
  "winner_variant_id": null,
  "variants": [],
  "stats": {
    "recipients": 18430,
    "sent": 18102,
    "delivered": 16877,
    "clicked": 905,
    "click_rate": 5
  },
  "created_at": "2026-10-06T14:58:02+00:00"
}

idintegeroptional

namestringoptional

statusenumoptional

Values: "draft" · "queued" · "queuing" · "sending" · "sent" · "failed" · "canceled"

typeenumoptional

Values: "instant" · "scheduled"

categoryobjectoptional

segment_idobjectoptional

segment_nameobjectoptional

Nome do público. Antes do envio, o nome atual do segmento; a partir do envio, o nome que o segmento tinha quando a campanha saiu, mesmo que ele seja renomeado ou apagado depois. null quando a campanha vai para todos os assinantes.

scheduled_atobject · date-timeoptional

sent_atobject · date-timeoptional

send_in_user_tzbooleanoptional

breakingbooleanoptional

recurrenceenumoptional

Values: "none" · "daily" · "weekly"

contentoptional

ab_testbooleanoptional

test_fractionobjectoptional

winner_variant_idobjectoptional

variantsarray<>optional

statsoptional

null enquanto a campanha está em draft, queued ou canceled.

created_atstring · date-timeoptional

401application/json

Chave ausente, inválida ou revogada.

{
  "message": "Credencial ausente ou inválida."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

404application/json

Não existe com esse ID neste site.

{
  "message": "Recurso não encontrado."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

429application/json

Limite de requisições excedido. Espere os segundos indicados em Retry-After.

{
  "message": "Muitas requisições. Tente novamente em instantes."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.