API Reference

/api/v3/sunburst/interview/config

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

Partially update the agent check-in configuration for the team. Only fields included in the request body are updated.

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

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

string
string

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

remind_channel
array of strings
remind_channel
string
alert_channel
array of strings
alert_channel
string

N or Active=Active, D or Disabled=Disabled

string

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 | null

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; send empty array to clear

checkin_include_agent_ids
notified_admin_agent_ids
array of integers

ADMIN-privilege agent IDs to receive check-in completion/missed notifications; send empty array to notify nobody

notified_admin_agent_ids
Responses
200

Config updated

400

activation_period_start is invalid

401

Requires admin or TC access

404

Config not found

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