Skip to main content
POST
Criar campanha

Authorizations

X-API-Key
string
header
required

Body

application/json
name
string
required

Nome único da campanha dentro da organização.

Required string length: 1 - 100
platform
enum<string>
required

Canal de envio da campanha. Define compatibilidade com templates oficiais e limites de cadência.

Available options:
whatsapp_lite,
whatsapp,
instagram
templateId
string
required

ID semântico do modelo de mensagem cadastrado no Spark.

cadence
integer
required

Mensagens por minuto (cadência). Ex.: 10 envia até 10 mensagens por minuto.

Required range: 1 <= x <= 9007199254740991
description
string

Descrição opcional da campanha.

Maximum string length: 2000
filters
object[]

Grupos de filtros de público-alvo. Grupos são combinados com AND.

Response

campaignId
string
required
status
enum<string>
required
Available options:
draft