Create Accessory

Create a new named AccessoryAccessory - A unique device within the system. An accessory can be any of type and is represented by a unique Accessory Id. An accessory is linked to an account via an accountId. Within this API, a singular Circle camera is an Accessory. owned by the requesting Account IdAccount Id - A unique non changing value to identify a particular Circle user account. Circle Account Id's are globally unique and are UUID v4 strings. The Account Id is not the same value as the Logitech Account Id found when introspecting an OAuth2 Authentication token. Example: 9385e6f9-70c3-45b2-62e4-ace3d027988a. This call is done in conjunction with the BLE discovery and provisioning process in the native mobile app.

Permissions

Requires a Permissions scope of: circle:accessories_manage

Response Body

Returns a JSON object with the following definition

Name

Type

Description

accessory

object

The new AccessoryAccessory - A unique device within the system. An accessory can be any of type and is represented by a unique Accessory Id. An accessory is linked to an account via an accountId. Within this API, a singular Circle camera is an Accessory. object. See (Get Accessory by Id)[ref:get-accessory-by-id) for the details of this object. The new Accessory IdAccessory Id - A unique non changing value to identify a particular Accessory. Accessory Id's are globally unique and are UUID v4 strings. A new Accessory Id is assigned by the servers when a device is associated to an account for the first time. If the same physical device is re-associated to the same account, it will receive the same Accessory Id again. If the same physical device is re-associated to a different account, it will receive a new Accessory Id. Example: 70e3e6f9-70c3-45b2-62e4-ace3d027988a is within this object.

countryCode

string

The ISO 3166-1 alpha 2 letter country code to provide to the camera via BLE for geolocation seeding.

forcedUpdate

boolean

Indicates whether the AccessoryAccessory - A unique device within the system. An accessory can be any of type and is represented by a unique Accessory Id. An accessory is linked to an account via an accountId. Within this API, a singular Circle camera is an Accessory. will need to be updated as soon as it comes online.

minVersion

string

The minimum firmware version required for the AccessoryAccessory - A unique device within the system. An accessory can be any of type and is represented by a unique Accessory Id. An accessory is linked to an account via an accountId. Within this API, a singular Circle camera is an Accessory.. Can be compared to the value found during BLE discovery.

nextVersion

string

The next firmware version to which the accessory will be updated.

serverHostname

string

The server hostname to pass to the camera during BLE setup.

serverPort

integer

The port to contact the serverHostname on. Passed to the camera via BLE.

Language
Authentication
OAuth2