Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Credentialing Outreach Resource

Send a practitioner credentialing outreach email

Sends a credentialing outreach email for a practitioner workflow via SendGrid and persists an outreach record in the DAL. Call this after a practitioner credentialing workflow is active and you need to contact one or more recipients; for facility credentialing outreach, use the facility-specific outreach endpoint instead. The request body must include at least one recipient in toEmails. For a single-workflow outreach, supply workflowId. For a multi-workflow (multi-tenant) outreach, supply workflowIds (two or more entries) and initiatingWorkflowId, which must be a member of workflowIds; attachments are not permitted on multi-workflow requests. Multi-tenant outreach must be enabled via the OUTREACH_MULTI_TENANT_ENABLED feature flag; when disabled, a multi-workflow request returns 503. This operation is not idempotent - each call dispatches a new email via SendGrid and persists a new outreach record.

post/credentialing-outreaches

Headers

tenant-idstring required

Tenant ID of the initiating organization; scopes the outreach record and email dispatch to this tenant.

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

Outreach email sent successfully. The response body shape depends on the request type: a single-workflow request (workflowId supplied) returns a bare string containing the created outreach record ID; a multi-workflow request (workflowIds with more than one entry) returns a MultiTenantOutreachResult object with an outreachId and a sends array describing the per-workflow send status.