Add

Add a device, which can either be owned by the network or shared with the network. The code provided can be either adoption code or a share code. Once a code is added, the device becomes an associated device until confirmation. If the device is a shared device, it will remain an associated device after confirmation.

POSThttps://api.bringyour.com/device/add

Authorization

Body

codestring

share code or adopt code

Response

Body

code_typeenum

shareadopt

codestring

device_namestring

Name of the device shared by the owner

associated_network_namestring

The name of the source network. Only for share codes.

client_idstring

udid. Only for share codes.

duration_minutesnumber

errorobject

messagestring

Request

Response

POSThttps://api.bringyour.com/device/add

Authorization

Body

codestring

share code or adopt code

Response

Body

code_typeenum

shareadopt

codestring

device_namestring

Name of the device shared by the owner

associated_network_namestring

The name of the source network. Only for share codes.

client_idstring

udid. Only for share codes.

duration_minutesnumber

errorobject

messagestring

Request

Response

const response = await fetch('https://api.bringyour.com/device/add', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "code_type": "share",
  "code": "text",
  "device_name": "text",
  "associated_network_name": "text",
  "client_id": "text",
  "duration_minutes": 0,
  "error": {
    "message": "text"
  }
}