Patch an existing facility

Allows you to change a facility's name or other data properties.

Request
path Parameters
facilityId
required
string <uuid>

Identifier of the facility to patch.

Request Body schema: application/json
name
string

If set, the facility's name will be updated with this value.

deactivated
boolean

If set to true, the facility will be deactivated. If set to false, the facility will be activated.

parentFacilityId
string <uuid>
dba
string

If set, the facility's DBA will be updated with this value.

addressLine1
string

If set, the facility's street address will be updated with this value.

addressLine2
string

If set, the facility's secondary address will be updated with this value.

city
string

If set, the facility's city will be updated with this value.

state
string

If set, the facility's state will be updated with this value.

Enum: "AL" "AK" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FL" "GA" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "OH" "OK" "OR" "PA" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VA" "WA" "WV" "WI" "WY" "AS" "GU" "MP" "PR" "VI"
zipCode
string

If set, the facility's zip code will be updated with this value.

phoneNumber
string

If set, the facility's phone number will be updated with this value.

faxNumber
string

If set, the facility's fax number will be updated with this value.

groupTaxId
string

If set, the facility's group tax id will be updated with this value.

facilityTaxId
string

If set, the facility's facility tax id will be updated with this value.

contactName
string

If set, the facility's contact name will be updated with this value.

contactEmail
string

If set, the facility's contact email will be updated with this value.

medicarePartANumber
string
medicarePartBNumber
string
medicaidNumber
string
Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

patch/facilities/{facilityId}
Request samples
application/json
{
  • "name": "string",
  • "deactivated": true,
  • "parentFacilityId": "ae79f421-c013-4bee-baba-e205d7217df1",
  • "dba": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "city": "string",
  • "state": "AL",
  • "zipCode": "string",
  • "phoneNumber": "string",
  • "faxNumber": "string",
  • "groupTaxId": "string",
  • "facilityTaxId": "string",
  • "contactName": "string",
  • "contactEmail": "string",
  • "medicarePartANumber": "string",
  • "medicarePartBNumber": "string",
  • "medicaidNumber": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deactivated": true,
  • "parentFacilityId": "ae79f421-c013-4bee-baba-e205d7217df1",
  • "dba": "string",
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "city": "string",
  • "state": "AL",
  • "zipCode": "string",
  • "phoneNumber": "string",
  • "faxNumber": "string",
  • "groupTaxId": "string",
  • "facilityTaxId": "string",
  • "contactName": "string",
  • "contactEmail": "string",
  • "medicarePartANumber": "string",
  • "medicarePartBNumber": "string",
  • "medicaidNumber": "string"
}