Skip to main content
PUT
Update Campaign

Authorizations

Authorization
string
header
required

Enter your API key: wave_live_<token>

Path Parameters

id
string
required

Body

application/json
title
string | null

Updated campaign title

messagesPerDay
integer | null

Updated daily limit (maximum limit is 60)

Required range: 1 <= x <= 60
workingDays
enum<string>[] | null

Active working days

Available options:
MONDAY,
TUESDAY,
WEDNESDAY,
THURSDAY,
FRIDAY,
SATURDAY,
SUNDAY
workingHours
string[] | null

Operating hours [start, end] in 24-hour UTC format (e.g. ['09:00', '18:00'])

increase_limit_gracefully
boolean | null

Graceful warmup ramp flag

list_ids
string[] | null

Updated target audience list UUIDs

timezone
string | null

Operating timezone in standard IANA format (e.g. 'Asia/Kolkata', 'America/New_York'). Working hours run according to 24-hour UTC format.

Response

Successful Response

id
string<uuid>
required

Campaign ID

title
string
required

Campaign title

status
enum<string>
default:LAUNCHED
Available options:
CREATED,
LAUNCHED,
PENDING,
COMPLETED,
MESSAGING_COMPLETED
active
boolean
default:true
messagesPerDay
integer | null
workingDays
enum<string>[] | null
Available options:
MONDAY,
TUESDAY,
WEDNESDAY,
THURSDAY,
FRIDAY,
SATURDAY,
SUNDAY
workingHours
string[] | null
account_id
string<uuid> | null
sequence_id
string<uuid> | null
increase_limit_gracefully
boolean | null
timezone
string | null
lists
PublicCampaignDetailListItem · object[] | null

Attached audience lists with id, name, and lead count

created_at
string<date-time> | null
updated_at
string<date-time> | null
total_leads
integer
default:0

Total leads across all attached audience lists

dms_sent
integer
default:0

Lifetime initial DMs sent

followups_sent
integer
default:0

Lifetime follow-up messages sent

replies_received
integer
default:0

Lifetime replies received

reply_rate
number
default:0

Reply percentage (0-100)