Skip to main content
GET
Get WhatsApp or SMS campaign

Authorizations

Authorization
string
header
required

API key created in the organization settings.

Path Parameters

template_campaign_id
string
required

Public ID of the WhatsApp or SMS campaign.

Pattern: ^tcp_[A-Za-z0-9_-]+$

Response

WhatsApp or SMS campaign found.

object
string
required
Allowed value: "template_campaign"
id
string
required
Pattern: ^tcp_[A-Za-z0-9_-]+$
status
string
required
channel
enum<string>
required
Available options:
whatsapp,
sms
is_official
boolean
required
scheduling_type
string
required
recipient_type
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string
scheduled_for
string<date-time>
sent_at
string<date-time>
templates
object[]
metrics
object
html_url
string<uri>