Skip to main content
PATCH
Update draft or scheduled campaign
You can only edit campaigns that are in draft or scheduled status. Campaigns that have already started cannot be modified.

Authorizations

Authorization
string
header
required

Project API key (sk_live… or sk_dev…). Send it as Authorization: Bearer <api_key>.

Path Parameters

_id
string
required

Campaign MongoDB id returned on create

Pattern: ^[a-fA-F0-9]{24}$

Body

application/json
name
string
Required string length: 3 - 80
templateId
string
Pattern: ^[a-fA-F0-9]{24}$
phoneNumberId
string
Pattern: ^[a-fA-F0-9]{24}$
category
enum<string>
Available options:
MARKETING,
UTILITY
scheduleType
enum<string>

Exactly two allowed values:

  • now — save as draft; start manually via POST .../start (scheduledFor not used)
  • schedulerequires scheduledFor (future datetime); saves as scheduled; auto-starts at that time
Available options:
now,
schedule
scheduledFor
string<date-time> | null

ISO-8601 datetime in the future when scheduleType is schedule

Response

Campaign updated

success
enum<boolean>
required
Available options:
true
data
object
required