Skip to main content
POST
/
connected_accounts
/
update
await seam.connectedAccounts.update({
  connected_account_id: "a289aa54-5488-4707-9a4b-eeea4edf311d",
  automatically_manage_new_devices: true,
  custom_metadata: { id: "internalId1" },
});

/*
// void
*/
{
  "connected_account": {
    "accepted_capabilities": [],
    "account_type_display_name": "<string>",
    "automatically_manage_new_devices": true,
    "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "custom_metadata": {},
    "display_name": "<string>",
    "errors": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>",
        "is_bridge_error": true,
        "is_connected_account_error": true
      }
    ],
    "warnings": [
      {
        "error_code": "<string>",
        "message": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "account_type": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "customer_key": "<string>",
    "image_url": "<string>",
    "user_identifier": {
      "api_url": "<string>",
      "email": "<string>",
      "exclusive": true,
      "phone": "<string>",
      "username": "<string>"
    }
  },
  "ok": true
}

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.

High-level device capabilities that can be restricted in connect webviews. These represent the main device categories that customers can opt into.

Available options:
lock,
thermostat,
noise_sensor,
access_control,
camera
​
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.

Minimum string length: 1

Response

OK

​
connected_account
object
required

Represents a connected account. A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.

​
ok
boolean
required