Skip to main content
POST
Crear campaña

Autorizaciones

Authorization
string
header
requerido

Autorización: Portador sk_live_xxxxx

Cuerpo

application/json

ID de plantilla requerido. canales ⊆ plantilla habilitadaCanales (whatsapp, sms, email, telegram). Con scheduledFor (≥ ~2 min), estado inicial PROGRAMADO. Grupo de envío de WhatsApp: configúrelo en el panel (la API de creación v1 aún no acepta sendPoolId).

name
string
requerido
Maximum string length: 128
templateId
string
requerido

Plantilla cuyo conjunto de canales habilitados restringe canales.

Minimum string length: 1
channels
enum<string>[]
requerido
Minimum array length: 1

Canal de campaña (crear/actualizar): whatsapp, sms, email, telegram. Debe ser un subconjunto de canales habilitados en la plantilla. Las plantillas pueden habilitar RCS/Push/voz; La campaña creada a través de API/panel utiliza estos cuatro.

Opciones disponibles:
whatsapp,
sms,
email,
telegram
segmentId
string
audienceContactIds
string[]
scheduledFor
string<date-time>

ISO-8601. Al menos ~2 minutos de antelación → estado PROGRAMADO.

instanceId
string | null

Instancia de WhatsApp (obligatoria en la práctica si incluye whatsapp y no hay ningún valor predeterminado en el espacio de trabajo).

telegramInstanceId
string | null

Instancia de Telegram (obligatoria en la práctica si incluye telegram y no hay un valor predeterminado en el espacio de trabajo).

fromEmail
string | null
variables
object

Fusionado encima de las propiedades del contacto al renderizar la plantilla.

Respuesta

Creado.

success
boolean
data
object

Campaña multicanal. canales ⊆ canales habilitados para plantilla (whatsapp|sms|email|telegram). Estado: BORRADOR, PROGRAMADO, EN EJECUCIÓN, COMPLETADO, FALLADO, CANCELADO.