Sign in

v7

latestOpenAPI 3.1.02026-08-08356409701.0 KB
Weekly notifications

Post Weekly Notifications

Upsert weekly digest notification targets (and optionally UTC weekly schedule) for the current org.

post/v1/weekly-notifications

Headers

X-API-Keystring required

API key required to authenticate requests.

Request body

preferred_send_time_utcstring nullable

UTC clock time when the weekly job runs, HH:MM:SS (e.g. 17:00:00). Must be sent together with day_of_week unless using clear_schedule.

day_of_weekinteger nullable

UTC weekday for the weekly instant: 0=Monday .. 6=Sunday (cron-style in UTC).

clear_scheduleboolean

If true, reset weekly send to the default (Monday 9:00 AM PST → UTC); still updates targets. Do not send with preferred_send_time_utc or day_of_week.

Response

Successful Response

successboolean
first_generate_at_utcstring nullable

From summaries-cron: first generate job fire (ISO UTC), if registered.

first_notify_at_utcstring nullable

From summaries-cron: first notify job fire (ISO UTC), if registered.

deferredboolean nullable

True if first fire was deferred by at least one week for lead-time safety.