Delete a Connected Account

Delete a Connected Account by ID

Deleting a connected account triggers a connected_account.deleted event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.

For example, if you delete a connected account with a device that has an access code, Seam sends a connected_account.deleted event, a device.deleted event, and an access_code.deleted event, but Seam does not remove the access code from the device.

/connected_accounts/delete

post

Authorizations

api_keypat_with_workspaceconsole_session_with_workspace

Body

connected_account_idstring · uuidrequired

syncboolean · default: falseoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://connect.getseam.com/connected_accounts/delete' \
  --header 'Authorization: Bearer API Key' \
  --header 'Content-Type: application/json' \
  --data '{
    "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
    "sync": true
  }'

200

400

401

200

{
  "ok": true
}

OK

Code Example

Python

seam.connected_accounts.delete("f891acfd-d228-4bb2-8399-c0f7e24e6b16")

cURL (bash)

curl -X 'POST' \
  'https://connect.getseam.com/connected_accounts/delete' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "connected_account_id": "f891acfd-d228-4bb2-8399-c0f7e24e6b16"
}'

# {
#   "ok": true
# }

JavaScript

await seam.connectedAccounts.delete({
  connected_account_id: "f891acfd-d228-4bb2-8399-c0f7e24e6b16"
})

PHP

$seam->connected_accounts->delete("f891acfd-d228-4bb2-8399-c0f7e24e6b16");

Java

seam.connectedAccounts().delete(ConnectedAccountsDeleteRequest.builder()
                .connectedAccountId("f891acfd-d228-4bb2-8399-c0f7e24e6b16")
                .build());

Parameters

connected_account_id	type: string	ID of the Connected Account

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

JSON

{
  "ok": true
}