Skip to main content
PATCH
Update campaign

Authorizations

X-API-KEY
string
header
required

Path Parameters

campaign_id
string
required

Body

application/json
name
string
description
string
campaign_type
enum<string>

Changing this re-validates the required agent bindings for the new type.

Available options:
voice,
whatsapp,
whatsapp_voice
status
string

Validated against the campaign status set, but prefer the /publish, /start, and /pause endpoints for lifecycle changes.

voice_agent_id
string

Must reference a published voice agent.

whatsapp_agent_id
string

Must reference a published whatsapp agent.

from_phone_number_id
string
whatsapp_sender_id
string
timezone
string

IANA timezone for the business hours and the agent's clock — same rules as Create campaign.

schedule
object

Business hours, retry policy and voice throttles — same shape as Create campaign.

workflow
object

Channel-specific config — same shape as Create campaign.

variables_schema
object
metadata
object

Response

The updated campaign