Retrieve the Full Details of a Single API Campaign

Retrieve the full details of a specific API campaign by its ID. Use this endpoint to inspect a campaign’s current status, verify which template it is linked to, and review its send counts.

Endpoint

GET https://connect.api-wa.co/project-apis/v1/project/{project_id}/campaign/api/{campaign_id}

Authentication

X-API-WA-Project-API-Pwd: YOUR_API_PASSWORD

Path Parameters

string

required

Your Convo project ID.

string

required

The unique ID of the API campaign. This is the _id field returned when you create a campaign or list campaigns.

Request Example

curl "https://connect.api-wa.co/project-apis/v1/project/YOUR_PROJECT_ID/campaign/api/64b3e1ac7f2c0a001d8e9f34" \
  -H "X-API-WA-Project-API-Pwd: YOUR_API_PASSWORD"

Response

A successful request returns 200 OK with the full campaign object.

string

The unique identifier of this campaign.

string

The campaign’s unique name within your project.

string

Campaign type. Always "API" for campaigns returned by this endpoint.

string

Current campaign status:

"LIVE" — Active and accepting send requests.
"PAUSED" — Temporarily suspended. Sends will be rejected until resumed.
"STOPPED" — Campaign has been stopped and is no longer active.

string

The media type of the linked template (e.g., "TEXT", "IMAGE", "VIDEO", "FILE").

object

The full payload for the campaign’s messages.

Show message_payload.template

string

The unique ID of the linked WhatsApp Message Template.

string

The template’s machine-readable name.

string

The template’s human-readable display label.

string

Approval status of the template: APPROVED, PENDING, REJECTED, or DISABLED.

string

Template category: TRANSACTIONAL, MARKETING, or OTP.

string

Template media type: TEXT, IMAGE, VIDEO, FILE, LOCATION, CAROUSEL, or ORDER_DETAILS.

string

Full language name for this template.

string

The message body text with {{n}} placeholders.

string

The message body with placeholders filled in with sample values.

integer

The number of dynamic placeholders in the template.

string

Button type: CTA, QuickReplies, All, or null.

array

Array of CTA button objects (type, button_title, button_value).

array

Array of quick reply label strings.

string

Footer text of the template.

integer

For API campaigns, this is always 0 — the audience is determined dynamically on each Send Campaign call.

integer

The total number of messages sent through this campaign since creation.

string

The Convo project this campaign belongs to.

string

ISO 8601 timestamp of when the campaign was created.

string

ISO 8601 timestamp of the most recent update to this campaign record.

Response Example

{
  "_id": "64b3e1ac7f2c0a001d8e9f34",
  "name": "ShipmentAlerts_Q4_2024",
  "type": "API",
  "status": "LIVE",
  "message_type": "TEXT",
  "message_payload": {
    "template": {
      "_id": "64a1f3bc9e4a2b001c3d7f12",
      "name": "shipping_update_v1",
      "label": "Shipping Update",
      "status": "APPROVED",
      "category": "TRANSACTIONAL",
      "type": "TEXT",
      "language": "English",
      "text": "Hi {{1}}, your order {{2}} has been shipped and will arrive by {{3}}.",
      "sample_text": "Hi Priya, your order #ORD-4521 has been shipped and will arrive by Dec 10.",
      "total_parameters": 3,
      "footer_text": "Reply STOP to unsubscribe",
      "message_action_type": "CTA",
      "call_to_action": [
        {
          "type": "URL",
          "button_title": "Track Order",
          "button_value": "https://example.com/track/{{1}}"
        },
        {
          "type": "Phone Number",
          "button_title": "Call Support",
          "button_value": "+919876543210"
        }
      ],
      "quick_replies": [],
      "isClickTrackingEnabled": true,
      "project_id": "YOUR_PROJECT_ID"
    }
  },
  "audience_size": 0,
  "submitted": 1482,
  "project_id": "YOUR_PROJECT_ID",
  "created_at": "2024-07-16T09:30:00.000Z",
  "updated_at": "2024-07-16T09:30:00.000Z"
}

Error Responses

Status	Description
`404 Not Found`	No API campaign with the given `campaign_id` exists in your project.
`500 Internal Server Error`	An unexpected server-side error occurred.

{
  "error": "Not Found",
  "message": "Campaign with id '64b3e1ac7f2c0a001d8e9f34' not found."
}

Overview

Business & Project

Messages

Contacts

Templates

Campaigns

Webhooks

Catalogue

Media

Retrieve the Full Details of a Single API Campaign

Endpoint

Authentication

Path Parameters

Request Example

Response

Response Example

Error Responses

​Endpoint

​Authentication

​Path Parameters

​Request Example

​Response

​Response Example

​Error Responses

Endpoint

Authentication

Path Parameters

Request Example

Response

Response Example

Error Responses