latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

FacilityCredentialingWorkflow

Replace all addresses on a facility workflow

Replaces the entire addresses array for the specified facility credentialing workflow with the list provided in the request body. When to use: Supply the complete desired list of addresses — omitting an existing address removes it. To clear all addresses, send an empty array []. Preconditions: The workflow must belong to the caller's tenant. Returns: 200 OK with the updated workflow section. Returns 404 if the workflow is not found, 400 if the request body is invalid.

put/facility-credentialing-workflows/{workflowId}/addresses

Path parameters

workflowIdstring required

Facility credentialing workflow ID

Headers

tenant-idstring required

Tenant ID

Request body

address1string required

Address Line 1

address2string required

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