Skip to main content
PUT
Update a campaign

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Resource identifier

Minimum string length: 1

Body

application/json
name
string
Required string length: 1 - 200
description
string
Maximum string length: 1000
type
enum<string>
Available options:
blast,
drip,
journey,
ad
channel
enum<string>
Available options:
sms,
mms,
whatsapp,
email,
rcs,
viber,
voice,
instagram,
messenger,
line,
push,
telegram,
fax
audience_type
enum<string>
Available options:
all,
list,
segment,
csv,
manual
audience_id
string
message_template
string
Maximum string length: 100000
variables
object
scheduled_at
string<date-time>
throttle_rate
integer
Required range: 0 <= x <= 1000
business_hours_only
boolean
smart_send
boolean

Response

The updated campaign.

The updated campaign.

data
object
meta
object