How to: Change the Participant State

For information about prerequisites, see Creating Participants.

When the device is first updated, its state is onboarding, to update the state of the device change its state to active as defined in its state machine configuration.

To update the state of the device, call the Update Participant State endpoint. Set the participantTypePluralName path parameter to the plural name of the device and the participantId path parameter to the Participant ID of the device. Pass a request body similar to the following:

{  
    "state":"active",  
    "subState":"active",  
    "callback":"{{callback_url}}"  
}