Skip to content

Channel Operations and Reference Data

When To Use It

Use this flow when an admin UI needs to list notification channels, create a new delivery channel, activate an existing channel, or resolve enum-backed reference data for configuration forms.

Prerequisites

  1. valid JWT session
  2. supported tenant or system portal entrypoint
  3. correct portal-level permissions for channel administration

Call Sequence

  1. load channel type reference data for form defaults
  2. query existing channels for the current institution
  3. create or update the target channel
  4. activate the channel when configuration is ready

Branch Decisions

  1. query-only admin view or mutation flow
  2. create a new email channel or adjust an existing one
  3. leave the channel inactive for staging or activate immediately

Common Failures

  1. calling notification channel endpoints from unsupported portals
  2. missing portal admin permissions
  3. bypassing portal ingress and losing X-PORTAL-ACCESS-CODE

Reference Entry

Internal Documentation