How to: Change the State of a Facility

For information about prerequisites, see Integrate with Facilities.

To change the state of a Facility, call the Transition Facility State endpoint and pass the following parameters in the request body:

toStateOne of the valid state codes: onboarding, active, deboarding, or inactive.
reasonCode (optional)A valid reason code associated with the event.
data (optional)Any additional information about the transition.

Request bodies are specified in JSON format. The following example request body shows how to change the state of the Facility:

  "toState": "active:available",
  "reasonCode": "R-104",
  "data": {}