Criar rascunho de campanha

POSThttps://app.sendapp.ai/api/campaigns/draft

Cria uma campanha como rascunho. Não envia nada: para a enviar, use depois o endpoint de arranque. Os destinatários são escolhidos por tag; a mensagem pode ser texto ou um template aprovado. No texto pode usar os marcadores {{name}}, {{phone}}, {{email}}.

Criar um rascunho NÃO envia mensagens. Para enviar é necessária uma chamada explícita ao endpoint de arranque.

Parâmetros

apikey obrigatório

A tua API Key.

token obrigatório

Token da conta.

name obrigatório

Nome da campanha.

channel obrigatório

whatsapp, whatsapp-web ou sms.

message_type obrigatório

template, text, text_media ou media_only.

message opcional

Texto da mensagem (para text / text_media).

template_name opcional

Nome do template (para message_type=template).

template_language opcional

Idioma do template.

media_url opcional

URL público do media (do endpoint de upload).

media_type opcional

image, audio, video ou document.

recipient_type opcional

all (todos os contactos) ou tags (filtrar por etiqueta). Padrão all.

tags opcional

Array de etiquetas dos destinatários (se recipient_type=tags).

scheduled_at opcional

Data/hora de envio agendado. Omitido = envio manual.

Pedido

curl -X POST 'https://app.sendapp.ai/api/campaigns/draft' \
  -H 'Content-Type: application/json' \
  -d '{
    "apikey": "YOUR_API_KEY",
    "token": "YOUR_ACCOUNT_TOKEN",
    "name": "Promo de verão",
    "channel": "whatsapp",
    "message_type": "template",
    "template_name": "promo_estate",
    "recipient_type": "tags",
    "tags": ["shopify"]
  }'

<?php
$ch = curl_init('https://app.sendapp.ai/api/campaigns/draft');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode([
        'apikey'         => 'YOUR_API_KEY',
        'token'          => 'YOUR_ACCOUNT_TOKEN',
        'name'           => 'Promo de verão',
        'channel'        => 'whatsapp',
        'message_type'   => 'template',
        'template_name'  => 'promo_estate',
        'recipient_type' => 'tags',
        'tags'           => ['shopify'],
    ]),
]);
echo curl_exec($ch); // { status:'success', campaign_id: 148 }

const res = await fetch('https://app.sendapp.ai/api/campaigns/draft', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    apikey: 'YOUR_API_KEY',
    token: 'YOUR_ACCOUNT_TOKEN',
    name: 'Promo de verão',
    channel: 'whatsapp',
    message_type: 'template',
    template_name: 'promo_estate',
    recipient_type: 'tags',
    tags: ['shopify']
  })
});
console.log(await res.json()); // { status:'success', campaign_id: 148 }

Resposta (200 OK)

{
  "status": "success",
  "message": "Draft saved.",
  "campaign_id": 512
}

Erro

{
  "status": "error",
  "message": "Draft not found or already launched."
}