Update a Connected Account
Updates a connected account.
Updates a connected account.
Code:
await seam.connectedAccounts.update({
connected_account_id: "a289aa54-5488-4707-9a4b-eeea4edf311d",
automatically_manage_new_devices: true,
custom_metadata: { id: "internalId1" },
});
Output:
// void
Request Parameters
connected_account_id
String (Required)
ID of the connected account that you want to update.
accepted_capabilities
Array of Enums
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
.
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. 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.
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.
Response
void
Last updated
Was this helpful?