---
title: "Opt Out Of Entitlements"
method: POST
path: "/v1/omni-ai/entitlements/opt-out"
tags: ["Omni AI"]
---

# Opt Out Of Entitlements

`POST /v1/omni-ai/entitlements/opt-out`

## Request

- Base URL: `https://api.clearstreet.com`
- URL: `https://api.clearstreet.com/v1/omni-ai/entitlements/opt-out`
- Auth: HTTP bearer

Turn off one-or-more entitlements for the given accounts. Idempotent:
accounts that are already opted out are left as they are. To turn an
entitlement back on, sign the agreement with `POST /omni-ai/entitlements`.

## Request body

- OptOutEntitlementsRequest
  - `account_ids` integer[], required
  - `entitlement_codes` EntitlementCode[], required

## Response `200`

Resulting status for the requested accounts

- object
  - `error` ApiError: A direct mapping of tonic::Status, for use in HTTP responses.
    - `code` integer, required: The error code is used to identify the nature of the error. It corresponds to an HTTP status code.
    - `details` object[]
    - `message` string, required: A human-readable message providing more details about the error.
  - `metadata` ResponseMetadata, required: Metadata for the response. This will always contain a request ID which can be used to identify the request to Clear Street for tracing, and optionally may include pagination data.
    - `next_page_token` string, byte, nullable: Base64URL-encoded pagination token
    - `page_number` integer, nullable: Pagination. Included if this was a GET (list) response
    - `previous_page_token` string, byte, nullable: Base64URL-encoded pagination token
    - `request_id` string, required: A unique ID for this request, generated upon ingestion of the request.
    - `total_items` integer, nullable: Total number of items available (not just in this page).
    - `total_pages` integer, nullable: Total number of pages available.
  - `data` EntitlementStatusResource[], required
    - `account_id` integer, required
    - `enabled` boolean, required
    - `entitlement_code` 'omni.account_data', required: Stable entitlement code granted by an agreement.

## Other responses

- `400`: Invalid request payload
- `403`: Caller lacks access to one or more requested accounts
- `500`: Internal server error

## Changes

- **2026-10-16** `1bd9eddeffc8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/clear-street/apis/clear-street-trading-api/changes/v1/omni-ai/entitlements/opt-out/post.md)

---

[API](https://skmtc.dev/clear-street/apis/clear-street-trading-api.md) - [All operations](https://skmtc.dev/clear-street/apis/clear-street-trading-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clear-street/apis/clear-street-trading-api/revisions/52e77ea7d731?raw)