v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

Credentialing Outreach Resource

Send a new credentialing outreach email

Sends a credentialing outreach email to one or more email addresses, with optional CC, BCC, reply-to, and attachments. The 'toEmails' field accepts a list of email addresses directly.

post/credentialing-outreaches

Headers

tenant-idstring required

Tenant ID

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"
  ],
  "subject": "Action Required: Complete Your Credentialing"
}

Response

Outreach email sent successfully. Two response shapes are possible: (1) Multi-tenant request (workflowIds.size > 1): body is MultiTenantOutreachResult with fields outreachId (String) and sends (PerWorkflowSendStatus[]). (2) Single-workflow request: body is a bare String containing the outreach record ID.