Skip to main content

Remove Accounts From Collection

PUT /v1/account/collection/accounts/remove

Removes one or more accounts from one or multiple account collections. Only collections that belong to the authenticated tenant are updated. The response returns the modified collections and metadata indicating which account IDs were removed and which were not found.

Request Body​

{
    "collectionIds": ["collection-id-1"],
    "accountIds": ["account-id-1", "account-id-2"]
  }

Response Example​

{
  "collections": [
    {
      "name": "Example Collection",
      "tenant": "tenant-id-1",
      "accountIds": ["account-id-1", "account-id-2"],
      "created": "2025-10-29T12:11:13.361Z",
      "updated": "2025-10-29T12:11:35.185Z",
      "deletedDate": null,
      "accounts": [],
      "id": "collection-id-1"
    }
  ],
  "metadata": {
    "accountsRemoved": ["account-id-1", "account-id-2"],
    "accountsNotFound": []
  }
}