Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Event Email Settings

Save event email settings for one context and mode

Creates or replaces event email settings for the given context and mode (upsert — if no record exists it is created, if one exists it is fully replaced). Both context and mode are matched against a case-sensitive route pattern — other casings return 404 at the routing layer before this operation executes. The request body should include a typeSettings array covering all six event-type values (initiated, approved, denied, cancelled, psvReady, inProgress), though this is not enforced by the server; any type with enabled: true must supply a non-blank template.subject and template.bodyHtml, otherwise the server returns 400. recipientPreferences is persisted at the context level and is shared across both modes for that context — changing it here also affects the other mode. Returns the full updated settings record. For updates only, PUT /{context}/{mode} is available and invokes this same upsert logic.

post/organizations/{organizationId}/event-email-settings/{context}/{mode}

Path parameters

context'practitioner' | 'facility' required

Context (practitioner or facility)

mode'credentialing' | 'recredentialing' required

Mode (credentialing or recredentialing)

organizationIdstring required

Organization identifier that scopes this request to a specific organization's event email settings. Path segment; opaque string, no enforced format.

Headers

tenant-idstring required

Tenant identifier of the requesting caller. Required on every request; opaque string, no enforced format.

Request body

ccEmailstring

CC email address applied to event emails for this context+mode. Stored at the mode level here — distinct from the context-level ccEmail settable via POST /{context}/cc-email, which takes priority on read when both are set. Must be a valid email address format (enforced by validation); omit to leave unset.

Response

The full event email settings record after the create/replace, including resolved recipient preferences, ccEmail, logoUrl, logoWidth, and per-type template settings.

context'practitioner' | 'facility' required

The context these settings apply to. "practitioner" covers practitioner-facing event emails; "facility" covers facility-facing ones.

mode'credentialing' | 'recredentialing' required

The workflow mode these settings apply to. "credentialing" is the initial verification cycle; "recredentialing" is the periodic renewal cycle.

ccEmailstring

Resolved CC email for this context+mode: the context-level ccEmail if set, otherwise falling back to a mode-level value (credentialing checked before recredentialing, regardless of the mode requested). Null if neither is set.

logoUrlstring

Resolved logo image URL for this context+mode, using the same context-then-credentialing-then-recredentialing fallback as ccEmail. Null if none is set.

logoWidthstring

Resolved logo display width for this context+mode, using the same fallback as ccEmail/logoUrl, as a percentage string (e.g. "50%"); no format is enforced server-side. Null if none is set.