PUT
/devices/{deviceId}/initiate-claim
http://devices.iot1click.{region}.amazonaws.com/devices/{deviceId}/initiate-claim<p>Given a device ID, initiates a claim request for the associated device.</p><note> <p>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.</p> </note>
Access Token Required: API Key
Path Parameters
deviceIdstringrequired
The unique identifier of the device.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request PUT \2 --url 'http://devices.iot1click.{region}.amazonaws.com/devices/{deviceId}/initiate-claim' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}