Sleeves

Sleeves are sub-models that you can use in more than one model. A sleeve has primary securities and security groups, each with a target weight from 0 to 100, as a model does.

You cannot assign a sleeve to a household or an account, and a sleeve cannot include another sleeve. To use a sleeve, add it to a model with a weight.

Each sleeve has an asset category, stock, bond, other or cash, and a region, US or global. They are labels that help you sort your sleeves.

To see which models include a sleeve, call List the models that use a sleeve.

📄️List sleeves

Returns your firm's sleeves, in ascending order of `id`. Unless you send `metrics=true`, the list does not include each sleeve's primary securities or security groups: call **Get a sleeve** for those.

📄️Create a sleeve

Creates a sleeve with the name, asset category, region, primary securities and security groups in the request body. To use the sleeve, add it to a model with **Create a model** or **Update a model**.

📄️List the models that use a sleeve

Returns your firm's models that include the sleeve with the given ID, in ascending order of `id`. Call it before **Delete a sleeve**. If your firm has no sleeve with that ID, the response is `404`.

📄️Get a sleeve

Returns the sleeve with the given ID, with its primary securities and security groups. If your firm has no sleeve with that ID, the response is `404`.

📄️Update a sleeve

Replaces the sleeve with the given ID with the one in the request body. Send every field: primary securities and security groups that you leave out of their arrays are removed from the sleeve. Other fields in the body, such as `id`, are ignored. If your firm has no sleeve with that ID, the response is `404`.

📄️Delete a sleeve

Deletes the sleeve with the given ID. First remove the sleeve from each model that includes it, with **Update a model**. To see those models, call **List the models that use a sleeve**. Returns `deleted: true`. If your firm has no sleeve with that ID, the response is `404`.