Skip to main content
POST
Create Campaign

Authorizations

Authorization
string
header
required

Enter your API key: wave_live_<token>

Body

application/json
title
string
required

Campaign title

Required string length: 1 - 150
Example:

"September Inbound Outbound"

account_id
string
required

Connected Instagram account UUID to send from

sequence_id
string
required

Outreach sequence UUID to use

list_ids
string[]
required

Target audience list UUIDs to process

Minimum array length: 1
messagesPerDay
integer | null
default:20

Maximum outbound messages per day (maximum limit is 60)

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

Days of the week to run outreach

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

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

increase_limit_gracefully
boolean | null
default:true

Gradually ramp up daily messaging limits for account safety

timezone
string | null
default:UTC

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
string<uuid>[] | null

Attached audience list UUIDs

created_at
string<date-time> | null
updated_at
string<date-time> | null