Set custom group assignments

PUT

/v1/custom-groups/assignments

Assigns holdings (by Symbol + Exchange) to custom-group categories. Each holding's
assignments are replaced with those supplied, and applied to that security across every
portfolio the user holds it in. Holdings not included in the request are left unchanged.

A group is identified by GroupId, falling back to GroupName when no ID is supplied.

A category is identified by Classification whenever that names a category of the group —
so changing it is how you move a holding to another category, and a CategoryId left beside
it from a previous read does not override that. CategoryId decides only when Classification
names no category of the group, which is what carries an assignment whose category has since
been renamed. Both stored names are taken from the group itself, so they stay correct.

Access

OAuth scope: portfolios:write

Available on: every plan, including free trials

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params

application/json-patch+json

Example

[
    {
        "symbol": "string",
        "exchange": "string",
        "displayExchange": "string",
        "name": "string",
        "groups": [
            {
                "groupId": 0,
                "groupName": "string",
                "categoryId": "string",
                "classification": "string"
            }
        ],
        "portfolioIds": [
            0
        ]
    }
]

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/v1/custom-groups/assignments' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--data '[
    {
        "symbol": "string",
        "exchange": "string",
        "displayExchange": "string",
        "name": "string",
        "groups": [
            {
                "groupId": 0,
                "groupName": "string",
                "categoryId": "string",
                "classification": "string"
            }
        ],
        "portfolioIds": [
            0
        ]
    }
]'

Responses

🟢204No Content

No Content

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429

Modified at 2026-09-29 03:33:53

List custom group assignments

Get account