Create Accessory

Create a new named Accessory owned by the requesting Account Id. 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 Accessory object. See (Get Accessory by Id)[ref:get-accessory-by-id) for the details of this object. The new Accessory Id 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 Accessory will need to be updated as soon as it comes online.

minVersion

string

The minimum firmware version required for the 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