Skip to main content
PUT
Update scheduled campaign

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign
integer
required

Campaign ID.

Body

application/json
type
enum<string>
required
Available options:
email,
sms
template_id
integer
required

Email or SMS communication template ID owned by the authenticated superadmin and matching type.

Example:

10

group_id
integer
required

Communication group ID owned by the authenticated superadmin.

Example:

25

frequency
enum<string>
required
Available options:
once,
daily,
weekly,
monthly
start_date
string<date>
required

Must be tomorrow or later and no more than one year from the request date for scheduled campaigns.

Example:

"2026-06-21"

end_date
string<date> | null

Required for daily, weekly, and monthly campaigns. Must be on or after start_date and no more than one year after start_date.

Example:

"2026-09-21"

day_of_week
integer | null

Required for weekly campaigns. Uses PHP/Carbon weekday numbering where 0 is Sunday and 6 is Saturday.

Required range: 0 <= x <= 6
Example:

1

day_of_month
integer | null

Required for monthly campaigns.

Required range: 1 <= x <= 31
Example:

15

Response

Campaign updated.

message
string
required
Example:

"Campaign updated."

data
object
required
Last modified on July 20, 2026