admin-proactive-programs

Change a proactive program's mode

Set how much one program may do: observe (runs, never sends), dm_only (DMs and reactions), full (also channel posts), or disabled (does not run). Widening past observe permits unprompted messages, so the change is recorded durably against the acting admin. The fire cursor is reconciled in the same transaction: a program that becomes runnable gets one, a program that stops being runnable gives up its cursor and lease.

patch/v1/admin/tenants/{tenant_id}/proactive-programs/{program_id}/mode

Request

  • Base URL: https://api.patricia.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.patricia.app/v1/admin/tenants/{tenant_id}/proactive-programs/{program_id}/mode
  • Auth: HTTP bearer

Path parameters

tenant_idstring uuid required
program_idstring uuid required

Request body

mode_code'observe' | 'dm_only' | 'full' | 'disabled' required

How much a proactive program may do (the staged rollout — §5.1, §7).

observe → the program runs (reads + reasons) but the delivery gate blocks EVERY outbound (it only records what it WOULD do); dm_only → DMs + reactions; full → also channel posts; disabled → the program does not run at all. Both programs seed dm_only; a mode change is staff-only.

enabledboolean nullable

Response

Successful Response

idstring uuid required
tenant_idstring uuid required
program_type_codestring required
mode_codestring required
enabledboolean required
schedulestring required
next_run_atstring date-time nullable required
last_run_atstring date-time nullable required
paused_reasonstring nullable required
paused_atstring date-time nullable required
consecutive_failuresinteger required
scopeobject required

Changes

No recorded changes to this operation across all 1 revision of this API.