latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Replace all addresses on a credentialing workflow

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

put/credentialing-workflows/{workflowId}/addresses

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

address1string required

Address Line 1

address2string

Address Line 2

citystring required

City

statestring required

State

countrystring

Country

zipcodestring required

Zipcode

sourcestring

Source of the address

typestring required

Type of the address

Example request

[
  {
    "createdBy": "user@example.com",
    "updatedBy": "admin@example.com",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "country": "USA",
    "zipcode": "94102",
    "source": "Manual Entry",
    "type": "mailing",
    "deletion": {
      "intent": "WORKFLOW_IRRELEVANCE",
      "reason": "OUT_OF_CREDENTIALING_SCOPE",
      "reasonText": "The practitioner is not in scope for this workflow"
    }
  }
]

Response

Addresses updated successfully

object required