latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Replace all phone numbers on a credentialing workflow

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

put/credentialing-workflows/{workflowId}/phone-numbers

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

phoneNumberstring required

Phone number

typestring required

Type of phone number

sourcestring

Source of the phone number

Example request

[
  {
    "createdBy": "user@example.com",
    "updatedBy": "admin@example.com",
    "phoneNumber": "+1-555-123-4567",
    "type": "Mobile",
    "source": "Manual Entry",
    "deletion": {
      "intent": "WORKFLOW_IRRELEVANCE",
      "reason": "OUT_OF_CREDENTIALING_SCOPE",
      "reasonText": "The practitioner is not in scope for this workflow"
    }
  }
]

Response

Phone numbers updated successfully

object required