Skip to main content

Update Account Collection By Id

PUT /v1/account/collection/:id

Updates an existing account collection by modifying its metadata or associated accounts. Use this to rename a collection, adjust account memberships, or sync account details. The response returns the updated collection with timestamps and populated account data for confirmation.

Request Body​

{
    "name": "Enterprise Customers"
  }

Response Example​

{
  "name": "Enterprise Customers",
  "tenant": "tenant-id-1",
  "accountIds": ["account-id-1", "account-id-2"],
  "created": "2025-10-22T08:15:43.741Z",
  "updated": "2025-10-22T08:17:23.920Z",
  "accounts": [
    {
      "id": "account-id-1",
      "name": "Example Account A"
    },
    {
      "id": "account-id-2",
      "name": "Example Account B"
    }
  ],
  "id": "collection-id-1"
}