Sign in
Event Email Settings

Set recipient preferences for an event email context

Updates the recipient preference flags for all event emails in the given context (practitioner or facility). Preferences are stored at context scope and apply to both the credentialing and recredentialing modes — changing them here overrides any mode-level preference values. The request body contains four boolean flags: primaryEmail, caqhPrimaryEmail, credentialingPrimaryContact, and credentialingOfficeManager; each controls whether that recipient type receives event emails. Returns the full EventEmailSettingsContextResponse for the context. These same preferences can also be set as part of a full mode save via POST /{context}/{mode}. Note: this path does not constrain or validate context beyond requiring the recipientPreferences object in the body — other string context values are silently accepted.

post/organizations/{organizationId}/event-email-settings/{context}/recipient-preferences

Path parameters

context'practitioner' | 'facility' required

Context (practitioner or facility)

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

Response

The full context settings record with the updated recipient preferences, including both mode summaries.

ccEmailstring

Resolved CC email for this context: the context-level value if set, otherwise falling back to the credentialing mode's value, then the recredentialing mode's value. Null if none is set.

logoUrlstring

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

logoWidthstring

Resolved logo display width for this context, 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.

mmoOutcomeFilterstring[]

Primary MMO (Managed Medical Outcomes) result types to send emails for. Allowed values: "Positive" (approved plan outcomes), "Negative" (denied plan outcomes). When the workflow has both approved and denied plan UDFs for the same event, the complementary outcome email is still sent regardless of this filter (e.g. filter ["Positive"] still sends the denied-plans email if present, and vice versa) — this filter narrows the primary outcome, it does not suppress the paired one. Null or empty = no restriction (both sent).

Changes

Changed in 1 of the 2 revisions of this API.24

  • 563848e0ecc024See the full diff
    • ●

      added the new inProgress enum value to the credentialing/typeSettings/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new inProgress enum value to the recredentialing/typeSettings/items/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the media type application/json for the response with the status 400

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 401

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 403

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 500

      response-media-type-added

    This revision also has 44 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog