URI HTTP methods Schemas Properties See also

Initiate Claim

Initiates a claim request for a device given its device ID.

URI

/devices/deviceId/initiate-claim

HTTP methods

PUT

Operation ID: InitiateDeviceClaim

Given a device ID, initiates a claim request for the associated device.

Note

Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.

Path parameters
Name	Type	Required	Description
`deviceId`	String	True	The unique identifier of the device.

Responses
Status code	Response model	Description
`200`	`DeviceClaimResponse`	200 response
`400`	`InvalidRequestException`	400 response
`404`	`ResourceNotFoundException`	404 response
`409`	`ResourceConflictException`	409 response
`500`	`InternalFailureException`	500 response

OPTIONS

Responses
Status code	Response model	Description
`200`	None	200 response

Schemas

Response bodies


{
  "state": "string"
}


{
  "code": "string",
  "message": "string"
}


{
  "code": "string",
  "message": "string"
}


{
  "code": "string",
  "message": "string"
}


{
  "code": "string",
  "message": "string"
}

Properties

DeviceClaimResponse

Property	Type	Required	Description
`state`	string	False	The device's final claim state.

InternalFailureException

Property	Type	Required	Description
`code`	string	False	500
`message`	string	False	The 500 error message returned by the web server.

InvalidRequestException

Property	Type	Required	Description
`code`	string	False	400
`message`	string	False	The 400 error message returned by the web server.

ResourceConflictException

Property	Type	Required	Description
`code`	string	False	409
`message`	string	False	An error message explaining the error or its remedy.

ResourceNotFoundException

Property	Type	Required	Description
`code`	string	False	404
`message`	string	False	The requested device could not be found.