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

POSThttps://connect.getseam.com/connected_accounts/update

Authorization

pat_with_workspaceconsole_session_with_workspaceapi_key

Body

application/json

connected_account_id*string (uuid)

automatically_manage_new_devicesboolean

custom_metadataobject

Response

200400401

OK

Body

application/json

connected_account*connected_account (object)

ok*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://connect.getseam.com/connected_accounts/update', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "connected_account_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

200

{
  "connected_account": {
    "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-12-21T12:20:06.170Z",
    "user_identifier": {
      "username": "text",
      "api_url": "text",
      "email": "text",
      "phone": "text",
      "exclusive": false
    },
    "account_type": "text",
    "account_type_display_name": "text",
    "errors": [
      {
        "message": "text",
        "is_connected_account_error": true,
        "error_code": "text"
      }
    ],
    "warnings": [
      {
        "message": "text",
        "warning_code": "text"
      }
    ],
    "automatically_manage_new_devices": false
  },
  "ok": false
}

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)

curl -X 'POST' \
  'https://connect.getseam.com/connected_accounts/update' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "connected_account_id": "6e1cad57-b244-40ca-b4f3-30a46c8000d4",
  "automatically_manage_new_devices": true,
  "custom_metadata": {
    "internal_account_id": "user-1"
  }
}'

JavaScript

const connectedAccountUpdate = await seam.connectedAccounts.update({
  connected_account_id: "6e1cad57-b244-40ca-b4f3-30a46c8000d4",
  automatically_manage_new_devices: true,
  custom_metadata: {
    "internal_account_id": "user-1"
  }
})

console.log(connectedAccountUpdate)

Ruby

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

puts connected_account_update.inspect

PHP

$connected_account_update = $seam->connected_accounts->update(
  connected_account_id: "6e1cad57-b244-40ca-b4f3-30a46c8000d4",
  automatically_manage_new_devices: true,
  custom_metadata: array('internal_account_id' => 'user-1')
)
echo json_encode($connected_account_update, JSON_PRETTY_PRINT);

Java

Map<String, CustomMetadataValue> customMetadata =
    Map.of("internal_account_id", CustomMetadataValue.of(Optional.of("user-1")));

seam.connectedAccounts().update(ConnectedAccountsUpdateRequest.builder()
        .connectedAccountId("6e1cad57-b244-40ca-b4f3-30a46c8000d4")
        .automaticallyManageNewDevices(true)
        .custom_metadata(customMetadata)
        .build());

Response

Returns a Boolean ok status indicator.

Sample Response

JSON

{
  "ok": true
}