Skip to main content
PATCH
Update Campaign

Headers

Authorization
string | null

Path Parameters

campaign_id
string<uuid>
required

Body

application/json

Request to update a draft campaign.

name
string | null
Required string length: 1 - 255
description
string | null
Maximum string length: 2000
template_id
string<uuid> | null
message_type
string | null
custom_message
string | null
message_payload
Message Payload · object | null
recipient_type
enum<string> | null

Campaign recipient selection mode.

Available options:
all,
group,
custom
recipient_group_ids
string<uuid>[] | null
recipient_contact_ids
string<uuid>[] | null
scheduled_for
string<date-time> | null

Response

Successful Response

Full campaign detail response.

id
string<uuid>
required
name
string
required
whatsapp_account_id
string<uuid>
required
recipient_type
string
required
status
string
required
total_recipients
integer
required
messages_sent
integer
required
messages_delivered
integer
required
messages_read
integer
required
messages_failed
integer
required
created_at
string
required
updated_at
string
required
description
string | null
template_id
string<uuid> | null
message_type
string
default:text
custom_message
string | null
message_payload
Message Payload · object | null
recipient_group_ids
string<uuid>[] | null
recipient_contact_ids
string<uuid>[] | null
scheduled_for
string | null
started_at
string | null
completed_at
string | null
cancelled_at
string | null
failed_at
string | null
error_message
string | null