Claim Code

A code is a value used to claim one or more devices.

URI

/claims/claimCode

Operation ID: ClaimDevicesByClaimCode

Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).

Path parameters
Name	Type	Required	Description
`claimCode`	String	True	The claim code, starting with "C-", as provided by the device manufacturer.

Responses
Status code	Response model	Description
`200`	`ClaimDevicesByClaimCodeResponse`	200 response
`400`	`InvalidRequestException`	400 response
`403`	`ForbiddenException`	403 response
`500`	`InternalFailureException`	500 response

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


{
  "total": integer,
  "claimCode": "string"
}


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


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


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

Property Type Required Description

Property	Type	Required	Description
`claimCode`	string MinLength: 12 MaxLength: 40	False	The claim code provided by the device manufacturer.
`total`	integer Format: int32	False	The total number of devices associated with the claim code that has been processed in the claim request.

claimCode

string

MinLength: 12

MaxLength: 40

False

The claim code provided by the device manufacturer.

total

integer

Format: int32

False

The total number of devices associated with the claim code that has been processed in the claim request.

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

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

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