v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

CredentialingWorkflow

Update addresses of a practitioner in a credentialing workflow

Replaces the entire addresses array with the provided list (RESTful PUT semantics).

put/credentialing-workflows/{workflowId}/addresses

Path parameters

workflowIdstring required

Credentialing workflow ID

Headers

tenant-idstring required

Tenant ID

Request body

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

createdAtstring date

createdBystring

The user who created the record

updatedAtstring date

updatedBystring

The user who last updated the record

Example request

[
  {
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "country": "USA",
    "zipcode": "94102",
    "source": "Manual Entry",
    "type": "mailing",
    "createdBy": "user@example.com",
    "updatedBy": "admin@example.com"
  }
]

Response

Addresses updated successfully

object required