Update a Connected Account

Update the properties of a specified connected account.

Updates any of the following properties of a specified connected account:

• automatically_manage_new_devices

• custom_metadata

/connected_accounts/update

post

Updates a connected account.

Authorizations

pat_with_workspaceconsole_session_with_workspaceapi_key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

connected_account_idstring · uuidRequired

ID of the connected account that you want to update.

automatically_manage_new_devicesbooleanOptional

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

customer_keystring · min: 1Optional

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.

Responses

200

OK

application/json

okbooleanRequired

400

Bad Request

401

Unauthorized

post

/connected_accounts/update

HTTPcURLJavaScriptPython

POST /connected_accounts/update HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
  "automatically_manage_new_devices": true,
  "custom_metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "accepted_capabilities": [
    "lock"
  ],
  "customer_key": "text"
}

{
  "connected_account": {
    "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2026-02-21T02:47:06.919Z",
    "account_type": "text",
    "account_type_display_name": "text",
    "image_url": "https://example.com",
    "display_name": "text",
    "errors": [
      {
        "created_at": "2026-02-21T02:47:06.919Z",
        "message": "text",
        "is_connected_account_error": true,
        "is_bridge_error": true,
        "error_code": "account_disconnected"
      }
    ],
    "warnings": [
      {
        "created_at": "2026-02-21T02:47:06.919Z",
        "message": "text",
        "warning_code": "scheduled_maintenance_window"
      }
    ],
    "custom_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "automatically_manage_new_devices": true,
    "customer_key": "text",
    "accepted_capabilities": [
      "lock"
    ]
  },
  "ok": true
}

Request

Specify the desired connected account by including the corresponding connected_account_id in the request body. In addition, in the request body, include the properties that you want to update, along with the desired replacement values.

Request Body Parameters

Parameter	Type	Description
connected_account_id	String Required	ID of the desired connected account
automatically_manage_new_devices	Boolean Optional	Indicates whether Seam should import all new devices for the connected account to make these devices available for use and management by the Seam API. You initially specify the value for this property when creating the corresponding Connect Webview.
custom_metadata	JSON object Optional	Specify up to 50 keys, with key names up to 40 characters long. Accepts string or Boolean values. Strings are limited to 500 characters. For more information, see Adding Custom Metadata to Connected Accounts.

Sample Request

Python

connected_account_update = seam.connected_accounts.update(
    connected_account_id = "6e1cad57-b244-40ca-b4f3-30a46c8000d4",
    automatically_manage_new_devices = True,
    custom_metadata = {
        "internal_account_id": "user-1"
    }
)

pprint(connected_account_update)

cURL (bash)

JavaScript

Ruby

PHP

Java

Response

Returns a Boolean ok status indicator.

Sample Response

JSON

{
  "ok": true
}