Create campaign

curl -X POST "https://api.pingr.ai/api/v1/campaigns" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q3 Lead Reactivation",
    "whatsapp_phone_number_id": "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
    "message_template_id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
    "audience_type": "tags",
    "audience_tags": ["high_intent", "q3_leads"],
    "scheduled_at": "2026-09-15T14:00:00Z"
  }'

import requests

url = "https://api.pingr.ai/api/v1/campaigns"

payload = {
    "name": "Q3 Lead Reactivation",
    "whatsapp_phone_number_id": "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
    "message_template_id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
    "audience_type": "tags",
    "audience_tags": ["high_intent", "q3_leads"],
    "scheduled_at": "2026-09-15T14:00:00Z"
}

headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)
print(response.status_code)
print(response.json())

const response = await fetch("https://api.pingr.ai/api/v1/campaigns", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name: "Q3 Lead Reactivation",
    whatsapp_phone_number_id: "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
    message_template_id: "3a4b5c6d-7e8f-9012-3456-789abcdef012",
    audience_type: "tags",
    audience_tags: ["high_intent", "q3_leads"],
    scheduled_at: "2026-09-15T14:00:00Z"
  })
});

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

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.pingr.ai/api/v1/campaigns"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("""
      {
        "name": "Q3 Lead Reactivation",
        "whatsapp_phone_number_id": "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
        "message_template_id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
        "audience_type": "tags",
        "audience_tags": ["high_intent", "q3_leads"],
        "scheduled_at": "2026-09-15T14:00:00Z"
      }
    """))
    .build();

HttpResponse<String> response =
    HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

{
  "id": "e4a2e584-3672-4d69-b541-6e9f1a238491",
  "organization_id": "93f35dc2-5d46-4e58-a9ee-038c35d9bcf1",
  "name": "Q3 Lead Reactivation",
  "whatsapp_phone_number_id": "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
  "message_template_id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
  "audience_type": "tags",
  "audience_tags": [
    "high_intent",
    "q3_leads"
  ],
  "audience_contact_ids": null,
  "scheduled_at": "2026-09-15T14:00:00Z",
  "status": "scheduled",
  "total_contacts_count": 0,
  "sent_count": 0,
  "delivered_count": 0,
  "read_count": 0,
  "failed_count": 0,
  "created_at": "2026-09-07T10:30:00Z",
  "updated_at": "2026-09-07T10:30:00Z"
}

{
  "detail": "WhatsApp channel/phone number not found for this organization."
}

{
  "detail": "Unauthorized"
}

{
  "error": "rate_limit_exceeded",
  "message": "Rate limit exceeded for endpoint. Please retry after backoff.",
  "retry_after": 60
}

POST

api

campaigns

curl -X POST "https://api.pingr.ai/api/v1/campaigns" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q3 Lead Reactivation",
    "whatsapp_phone_number_id": "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
    "message_template_id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
    "audience_type": "tags",
    "audience_tags": ["high_intent", "q3_leads"],
    "scheduled_at": "2026-09-15T14:00:00Z"
  }'

import requests

url = "https://api.pingr.ai/api/v1/campaigns"

payload = {
    "name": "Q3 Lead Reactivation",
    "whatsapp_phone_number_id": "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
    "message_template_id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
    "audience_type": "tags",
    "audience_tags": ["high_intent", "q3_leads"],
    "scheduled_at": "2026-09-15T14:00:00Z"
}

headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)
print(response.status_code)
print(response.json())

const response = await fetch("https://api.pingr.ai/api/v1/campaigns", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name: "Q3 Lead Reactivation",
    whatsapp_phone_number_id: "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
    message_template_id: "3a4b5c6d-7e8f-9012-3456-789abcdef012",
    audience_type: "tags",
    audience_tags: ["high_intent", "q3_leads"],
    scheduled_at: "2026-09-15T14:00:00Z"
  })
});

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

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.pingr.ai/api/v1/campaigns"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("""
      {
        "name": "Q3 Lead Reactivation",
        "whatsapp_phone_number_id": "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
        "message_template_id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
        "audience_type": "tags",
        "audience_tags": ["high_intent", "q3_leads"],
        "scheduled_at": "2026-09-15T14:00:00Z"
      }
    """))
    .build();

HttpResponse<String> response =
    HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

{
  "id": "e4a2e584-3672-4d69-b541-6e9f1a238491",
  "organization_id": "93f35dc2-5d46-4e58-a9ee-038c35d9bcf1",
  "name": "Q3 Lead Reactivation",
  "whatsapp_phone_number_id": "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
  "message_template_id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
  "audience_type": "tags",
  "audience_tags": [
    "high_intent",
    "q3_leads"
  ],
  "audience_contact_ids": null,
  "scheduled_at": "2026-09-15T14:00:00Z",
  "status": "scheduled",
  "total_contacts_count": 0,
  "sent_count": 0,
  "delivered_count": 0,
  "read_count": 0,
  "failed_count": 0,
  "created_at": "2026-09-07T10:30:00Z",
  "updated_at": "2026-09-07T10:30:00Z"
}

{
  "detail": "WhatsApp channel/phone number not found for this organization."
}

{
  "detail": "Unauthorized"
}

{
  "error": "rate_limit_exceeded",
  "message": "Rate limit exceeded for endpoint. Please retry after backoff.",
  "retry_after": 60
}

Create a new outbound campaign for your organization. If scheduled_at is omitted or in the past, sending begins immediately via background workers. If scheduled_at is in the future, the campaign is scheduled via TaskIQ and stored with status scheduled.

Authentication

This endpoint requires Bearer token authentication.

Authorization: Bearer <token>

Header	Type	Required	Description	Format
`Authorization`	`string`	Yes	Scoped organization API key or Bearer JWT token	`Bearer <token>`

Input parameters

The following parameters are accepted in the JSON request body.

string

required

Bearer token for authentication. Format: Bearer <token>.

string

required

Descriptive title of the campaign (maximum 255 characters). Example: Summer Sale Launch.

string

required

UUID of the registered WhatsApp Business phone number configured for your organization.

string

UUID of the approved WhatsApp message template to broadcast.

string

default:"all"

Audience resolution strategy:

all: Broadcasts to all contacts registered in the organization.
tags: Filters contacts matching any tags specified in audience_tags.
manual: Dispatches only to the contacts listed in audience_contact_ids.

string[]

Array of contact tags to target when audience_type is set to tags. Example: ["vip", "q3_leads"].

string[]

Array of contact UUIDs to target when audience_type is set to manual.

string

ISO 8601 timestamp (e.g. 2026-09-15T14:30:00Z) for future dispatch. Leave empty to begin dispatching immediately.

Response Fields

string

Generated UUID identifier of the campaign.

string

UUID of the owning organization.

string

Campaign name.

string

Initial status of the campaign (sending for immediate dispatch, or scheduled for future delivery).

string

UUID of the sending WhatsApp phone number channel.

string

UUID of the message template, or null.

string

Targeting strategy (all, tags, or manual).

string[]

Array of targeted tags, or null.

string[]

Array of targeted contact IDs, or null.

string

ISO 8601 scheduled dispatch timestamp, or null.

number

Total number of recipient contacts resolved for this campaign.

number

Count of messages dispatched.

number

Count of messages confirmed delivered.

number

Count of messages marked read by recipients.

number

Count of messages that failed delivery.

string

ISO 8601 creation timestamp.

string

ISO 8601 last modification timestamp.

curl -X POST "https://api.pingr.ai/api/v1/campaigns" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q3 Lead Reactivation",
    "whatsapp_phone_number_id": "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
    "message_template_id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
    "audience_type": "tags",
    "audience_tags": ["high_intent", "q3_leads"],
    "scheduled_at": "2026-09-15T14:00:00Z"
  }'

import requests

url = "https://api.pingr.ai/api/v1/campaigns"

payload = {
    "name": "Q3 Lead Reactivation",
    "whatsapp_phone_number_id": "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
    "message_template_id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
    "audience_type": "tags",
    "audience_tags": ["high_intent", "q3_leads"],
    "scheduled_at": "2026-09-15T14:00:00Z"
}

headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)
print(response.status_code)
print(response.json())

const response = await fetch("https://api.pingr.ai/api/v1/campaigns", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name: "Q3 Lead Reactivation",
    whatsapp_phone_number_id: "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
    message_template_id: "3a4b5c6d-7e8f-9012-3456-789abcdef012",
    audience_type: "tags",
    audience_tags: ["high_intent", "q3_leads"],
    scheduled_at: "2026-09-15T14:00:00Z"
  })
});

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

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.pingr.ai/api/v1/campaigns"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString("""
      {
        "name": "Q3 Lead Reactivation",
        "whatsapp_phone_number_id": "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
        "message_template_id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
        "audience_type": "tags",
        "audience_tags": ["high_intent", "q3_leads"],
        "scheduled_at": "2026-09-15T14:00:00Z"
      }
    """))
    .build();

HttpResponse<String> response =
    HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

{
  "id": "e4a2e584-3672-4d69-b541-6e9f1a238491",
  "organization_id": "93f35dc2-5d46-4e58-a9ee-038c35d9bcf1",
  "name": "Q3 Lead Reactivation",
  "whatsapp_phone_number_id": "8f3b0e2a-71d3-4a5f-9e6b-123456789abc",
  "message_template_id": "3a4b5c6d-7e8f-9012-3456-789abcdef012",
  "audience_type": "tags",
  "audience_tags": [
    "high_intent",
    "q3_leads"
  ],
  "audience_contact_ids": null,
  "scheduled_at": "2026-09-15T14:00:00Z",
  "status": "scheduled",
  "total_contacts_count": 0,
  "sent_count": 0,
  "delivered_count": 0,
  "read_count": 0,
  "failed_count": 0,
  "created_at": "2026-09-07T10:30:00Z",
  "updated_at": "2026-09-07T10:30:00Z"
}

{
  "detail": "WhatsApp channel/phone number not found for this organization."
}

{
  "detail": "Unauthorized"
}

{
  "error": "rate_limit_exceeded",
  "message": "Rate limit exceeded for endpoint. Please retry after backoff.",
  "retry_after": 60
}

‹ Previous

List campaigns

GET /api/v1/campaigns

Next ›

Overview

Agents

Campaigns

Contacts

Templates

Knowledge Base

Webhooks

Call Logs

Quick Replies

Inbox

Authentication

Input parameters

Response Fields

​Authentication

​Input parameters

​Response Fields

Authentication

Input parameters

Response Fields