latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Replace all contact emails on a credentialing workflow

Replaces the entire emails list on the credentialing workflow identified by workflowId with the provided array (full-replacement PUT semantics). Any email currently on the workflow that is not in the request body will be removed. Send an empty array ([]) to clear all emails.

put/credentialing-workflows/{workflowId}/emails

Path parameters

workflowIdstring required

Credentialing workflow ID

Headers

tenant-idstring required

Tenant ID

Request body

createdAtstring date

createdBystring

The user who created the record

updatedAtstring date

updatedBystring

The user who last updated the record

emailstring required

Email address

emailTypestring required

Type of email

sourcestring

Source of the email

Example request

[
  {
    "createdBy": "user@example.com",
    "updatedBy": "admin@example.com",
    "email": "doctor@example.com",
    "emailType": "credentialing",
    "source": "Manual Entry",
    "deletion": {
      "intent": "WORKFLOW_IRRELEVANCE",
      "reason": "OUT_OF_CREDENTIALING_SCOPE",
      "reasonText": "The practitioner is not in scope for this workflow"
    }
  }
]

Response

Emails updated successfully

object required