API Reference

/api/v3/sunburst/interview/config

post
https://api.sisu.co/api/v3/sunburst/interview/config

Create a new agent check-in configuration for the team.

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

Check-in cadence; case-insensitive (W=Weekly, B=Bi-Weekly, M=Monthly)

string

Custom check-in instructions

string

Reminder frequency; case-insensitive (D=Daily, W=Weekly, A=Every Other Day)

remind_channel
array of strings

Reminder channels (S=SMS, E=Email)

remind_channel
string

Alert rule

alert_channel
array of strings

Alert channels (S=SMS, E=Email)

alert_channel
string

Starting day of week; accepts two-char abbreviation (MO/TU/WE/TH/FR/SA/SU, case-insensitive) or JS numeric day index (0=Sun…6=Sat)

string

Hour of day check-ins are due, 24-hour two-digit string (e.g. '17' for 5 PM)

integer

Hours after the due time an incomplete check-in can still be completed (0-120)

string

Backdate the first active check-in period to this date (must be today or earlier); only honored before any check-ins exist for the team

boolean
boolean
boolean
boolean
checkin_include_agent_ids
array of integers

Agent IDs of non-agent-role team members to include in check-ins

checkin_include_agent_ids
notified_admin_agent_ids
array of integers

ADMIN-privilege agent IDs to receive check-in completion/missed notifications

notified_admin_agent_ids
Responses
201

Config created

400

cadence is required, or activation_period_start is invalid

401

Requires admin or TC access

409

Config already exists

422

notified_admin_agent_ids contains an id that isn't an ADMIN-privilege agent on the team

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