Add Account To Collection

PUT /v1/account/collection/accounts/add

Adds multiple accounts to one or more existing account collections in a single operation. This endpoint enables efficient bulk management of account memberships within collections, reducing redundant individual updates. Only accounts accessible by the authenticated tenant are processed, ensuring security and data consistency. It is particularly useful for maintaining logical groupings such as customer tiers, partner lists, or supplier categories.

Request Body

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

Response Example

{
  "collections": [
    {
      "name": "Example Premium Customers",
      "tenant": "tenant-id-1",
      "accountIds": ["account-id-1", "account-id-2", "account-id-3"],
      "created": "2025-10-29T12:00:00Z",
      "updated": "2025-10-29T12:05:00Z",
      "accounts": [],
      "id": "collection-id-1"
    }
  ],
  "metadata": {
    "accountsAdded": ["account-id-1", "account-id-2", "account-id-3"],
    "accountsExists": [],
    "accountsNotFound": []
  }
}