CLclear-street
Omni AI

Opt Out Of Entitlements

Changed on

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.

post/v1/omni-ai/entitlements/opt-out

Request

  • Base URL
    https://api.clearstreet.com
  • Auth
    HTTP bearer

Request body

account_idsinteger[] required
entitlement_codesEntitlementCode[] required

Example request

{
  "account_ids": [
    100019,
    100021
  ],
  "entitlement_codes": [
    "omni.account_data"
  ]
}

Response

Resulting status for the requested accounts

Example response

{
  "error": {
    "code": 400,
    "message": "Order quantity must be greater than zero"
  },
  "metadata": {
    "page_number": 1,
    "total_items": 42,
    "total_pages": 5
  }
}

Changes