/api/v3/sunburst/scheduled-prompt

post

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

Create a new scheduled prompt.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

prompt

string

required

Prompt text (max 5000 chars)

title

string

required

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

teaser

string

required

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

delivery_time

string

required

Run time in HH:MM (24-hour) format

cadence

string

'Weekly' (default) or 'Monthly'

scheduled_days

array of strings

Day codes (Mo, Tu, We, Th, Fr, Sa, Su). Required when cadence is Weekly.

scheduled_days

day_of_month

integer

Fixed day of the month (1-31), evaluated in the team's timezone. Required when cadence is Monthly. Days beyond a given month's length (e.g. 31 in February) fire on that month's last day.

recipients

array of strings

required

Recipient codes in a{agent_id} format

recipients*

channels

array of strings

required

Delivery channels: email, sms

channels*

Responses

201

Created

400

Validation error

401

Requires admin access

403

Team is not licensed for Sunburst

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here!