Console

Create campaign

.md

POST

https://whatsapp.paaltech.org/api/v1/businesses/{external_id}/campaigns

Token ability: campaigns.manage · Authentication

A draft broadcast of one APPROVED template to a segment or a list of contacts. parameters maps each template variable to a source per contact - field:name (name, phone, email, external_id), custom:<key> or text:<fixed text>. Preview it, then launch it - now, at send_at, or repeating every week or month.

Path parameters

external_id string required

Your own ID for the business (Multi-SKUUL - the tenant ID).

Max 191 characters. Pattern ^[A-Za-z0-9._:-]+$.

Body parameters

name string required

Max 191 characters.

template object required

name string required template.name

language string required template.language

parameters object

segment_id integer | null

The audience - or contact_ids.

contact_ids array of integers | null

Max 10000 items.

phone_number_id string | null

category string | null

One of: marketing, notifications, transactional, ``.

topic string | null

One of: fees, results, attendance, pta, marketing, system, ``.

send_at string | null

Format date-time.

repeat string | null

One of: week, month, ``.

per_minute integer | null

Pace: messages per minute (default 60).

Responses

201

The draft.

401

unauthenticated - missing, invalid, revoked or expired token

403

missing_ability, product_suspended or product_token_required

404

not_found - not yours, or does not exist

422

validation_failed or unknown_template.

429

rate_limited - over 300 requests/minute for this product

Errors always look like {"error": {"code", "message"}} - see Errors and status codes.

Language

Credentials

Authorization Bearer $PAALCHAT_TOKEN

Request

cURL

curl --request POST \
  --url 'https://whatsapp.paaltech.org/api/v1/businesses/presec/campaigns' \
  --header "Authorization: Bearer $PAALCHAT_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "October fee reminders",
  "template": {"name": "school_fee_reminder", "language": "en_US"},
  "parameters": {
    "parent": "field:name",
    "amount": "custom:fee_balance",
    "student": "custom:ward_name",
    "due_date": "text:30 October"
  },
  "segment_id": 4,
  "topic": "fees"
}'

const response = await fetch('https://whatsapp.paaltech.org/api/v1/businesses/presec/campaigns', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.PAALCHAT_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "October fee reminders",
    "template": {"name": "school_fee_reminder", "language": "en_US"},
    "parameters": {
      "parent": "field:name",
      "amount": "custom:fee_balance",
      "student": "custom:ward_name",
      "due_date": "text:30 October"
    },
    "segment_id": 4,
    "topic": "fees"
  }),
});

const data = await response.json();
console.log(response.status, data);

use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('PAALCHAT_TOKEN'))
    ->acceptJson()
    ->post('https://whatsapp.paaltech.org/api/v1/businesses/presec/campaigns', [
        'name' => 'October fee reminders',
        'template' => ['name' => 'school_fee_reminder', 'language' => 'en_US'],
        'parameters' => [
            'parent' => 'field:name',
            'amount' => 'custom:fee_balance',
            'student' => 'custom:ward_name',
            'due_date' => 'text:30 October',
        ],
        'segment_id' => 4,
        'topic' => 'fees',
    ]);

$data = $response->json();

import os
import requests

response = requests.post(
    "https://whatsapp.paaltech.org/api/v1/businesses/presec/campaigns",
    headers={"Authorization": f"Bearer {os.environ['PAALCHAT_TOKEN']}", "Accept": "application/json"},
    json={
        "name": "October fee reminders",
        "template": {"name": "school_fee_reminder", "language": "en_US"},
        "parameters": {
            "parent": "field:name",
            "amount": "custom:fee_balance",
            "student": "custom:ward_name",
            "due_date": "text:30 October",
        },
        "segment_id": 4,
        "topic": "fees",
    },
)

print(response.status_code, response.json())

require 'net/http'
require 'json'

uri = URI('https://whatsapp.paaltech.org/api/v1/businesses/presec/campaigns')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = "Bearer #{ENV['PAALCHAT_TOKEN']}"
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
  {
    "name": "October fee reminders",
    "template": {"name": "school_fee_reminder", "language": "en_US"},
    "parameters": {
      "parent": "field:name",
      "amount": "custom:fee_balance",
      "student": "custom:ward_name",
      "due_date": "text:30 October"
    },
    "segment_id": 4,
    "topic": "fees"
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.code, JSON.parse(response.body)

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	req, err := http.NewRequest("POST", "https://whatsapp.paaltech.org/api/v1/businesses/presec/campaigns", strings.NewReader(`{
  "name": "October fee reminders",
  "template": {"name": "school_fee_reminder", "language": "en_US"},
  "parameters": {
    "parent": "field:name",
    "amount": "custom:fee_balance",
    "student": "custom:ward_name",
    "due_date": "text:30 October"
  },
  "segment_id": 4,
  "topic": "fees"
}`))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAALCHAT_TOKEN"))
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

Try it with a test key

Only sk_test_ keys: requests reach your sandbox businesses, never real ones. The key is not saved.

Test key

external_id

JSON body

Response

Response

{
  "error": {"code": "unauthenticated", "message": "A valid product token is required."}
}

{
  "error": {
    "code": "missing_ability",
    "message": "This token does not have the ability this request needs."
  }
}

{"error": {"code": "not_found", "message": "Business not found."}}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Slow down and retry after the Retry-After header."
  }
}