API Reference

/api/v3/sunburst/scheduled-prompt

patch
https://api.sisu.co/api/v3/sunburst/scheduled-prompt

Partially update a scheduled prompt. Only fields included in the request body are updated. Pass status as "Active" or "Inactive" to toggle the schedule.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
string
string

Subject line / SMS lead-in for the delivered message (max 256 chars)

string

One-line hook shown in the message body (max 256 chars)

string
string

'Weekly' or 'Monthly'

scheduled_days
array of strings

Required if switching to/staying on Weekly cadence.

scheduled_days
integer

Required if switching to/staying on Monthly cadence (1-31).

recipients
array of strings
recipients
channels
array of strings
channels
string

Active or Inactive

Responses
200

Updated

400

Validation error

401

Requires admin access

403

Team is not licensed for Sunburst

404

Schedule not found

Updated 4 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 4 months ago