Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Facility Credentialing Outreach Resource

Send a facility credentialing outreach email

Triggers a credentialing outreach email for a facility credentialing workflow by dispatching it through SendGrid and persisting a new outreach record. This operation is not idempotent - every call sends another email and creates another outreach record. Call it after the target facility credentialing workflow already exists. For a single-workflow outreach, supply workflowId. For a multi-tenant outreach that fans out to two or more recipient workflows, supply workflowIds (two or more entries) together with initiatingWorkflowId, which must be one of the entries in workflowIds; workflowId and workflowIds are mutually exclusive. Any file attachments must already be uploaded to Google Cloud Storage before calling this endpoint - the request only references them by metadata. For multi-workflow requests only, the initiating tenant (identified by the tenant-id header) must have a fully configured outreach-settings template (subject and body) for the relevant credentialing cycle, or the request is rejected with 422; single-workflow requests do not perform this template check. Multi-workflow requests also require the OUTREACH_MULTI_TENANT_ENABLED feature flag to be enabled, or they are rejected with 503; single-workflow requests are unaffected by this flag.

post/facility-credentialing-outreaches

Headers

tenant-idstring required

Tenant ID of the initiating organization. Scopes the outreach record and email dispatch to this tenant, and identifies whose outreach-settings template is applied to the send.

Request body

workflowIdstring

The workflow ID for the credentialing outreach. Required for single-workflow requests. When workflowIds is provided with more than one entry, this field is optional.

workflowIdsstring[]

List of workflow IDs for multi-tenant outreach. When more than one entry is provided, initiatingWorkflowId must also be set. Single-workflow requests should leave this null and use workflowId instead.

initiatingWorkflowIdstring

The workflow ID of the initiating org for multi-tenant outreach. Required when workflowIds contains more than one entry. Must be present in the workflowIds list. The initiating workflow's tenant outreach-settings template is applied to all bundled workflows.

toEmailsstring[] required

List of email addresses to send the outreach email to

bodystring required

Email body content

ccEmailsstring[]

Optional list of CC email addresses

bccEmailsstring[]

Optional list of BCC email addresses

outreachReasonsstring[] required

List of reasons for the outreach

subjectstring required

Email subject line

multiTenantboolean

Example request

{
  "workflowId": "workflow-123",
  "workflowIds": [
    "workflow-123",
    "workflow-456"
  ],
  "initiatingWorkflowId": "workflow-123",
  "toEmails": [
    "recipient@example.com"
  ],
  "body": "Please complete your credentialing application.",
  "ccEmails": [
    "cc@example.com"
  ],
  "bccEmails": [
    "bcc@example.com"
  ],
  "outreachReasons": [
    "Missing documentation",
    "Expired license"
  ],
  "outreachReasonsWithLabels": [
    {
      "id": "reason-123",
      "label": "Missing documentation"
    }
  ],
  "subject": "Action Required: Complete Your Credentialing"
}

Response

The outreach email was sent and a new outreach record was created. A single-workflow request returns a bare JSON string containing the new outreach record ID. A multi-workflow request returns an object with outreachId (the single outreach record shared by all bundled workflows) and sends (one entry per workflow with workflowId, tenantId, emailId, status of SENT or FAILED, sendgridId, and errorMessage - the last three are null on whichever branch did not occur).