Skip to main content
PATCH
Updates a connected account.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
connected_account_id
string<uuid>
required

ID of the connected account that you want to update.

accepted_capabilities
enum<string>[]

List of accepted device capabilities that restrict the types of devices that can be connected through this connected account. Valid values are lock, thermostat, noise_sensor, and access_control.

Available options:
lock,
thermostat,
noise_sensor,
access_control,
camera,
speaker,
pool
automatically_manage_new_devices
boolean

Indicates whether newly-added devices should appear as managed devices.

custom_metadata
object

Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). Adding custom metadata to a connected account enables you to store custom information, like customer details or internal IDs from your application. Then, you can filter connected accounts by the desired metadata. Set a key to null or to an empty string to remove that key from the custom metadata.

customer_key
string

The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.

display_name
string

Human-readable name for the connected account, shown in the dashboard. For example, Booking from Airbnb House 1.

Response

200

OK