Skip to main content
PATCH
Update a scheduled campaign

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
name
string

Campaign display name shown in the campaigns list.

message
string

SMS body used when isAutopilot is false; supports {{firstName}}-style placeholders.

scheduleDate
string<date-time>

ISO timestamp when the campaign should fire; null sends immediately.

isAutopilot
boolean

When true, the AI prompt drives the campaign instead of using the message body verbatim.

process
string

Prompt _id used to drive AI replies for this campaign.

status
string

Lifecycle status: scheduled, sent, failed, partial success, or cancelled.

segmentProcesses
object[]

Per-segment overrides keyed by stage _id.

segmentStatuses
object[]

Per-segment overrides keyed by stage _id.

segmentSchedules
object[]

Per-segment overrides keyed by stage _id.

Response

Campaign updated

success
boolean
message
string
data
object
Example: