CLclear-street
Omni AI

Create Entitlements

Changed on

Record consent and upsert one-or-more active grants.

post/v1/omni-ai/entitlements

Request

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

Request body

account_idsinteger[] required
agreement_idstring required
entitlement_codesEntitlementCode[] required

Example request

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

Response

Resulting active grants for requested scope

Example response

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

Changes

  • ae04ae681b64Revision changes
    • breaking

      removed the required property /// from the response with the status

    • info

      added the required property /// to the response with the status

  • 169e8b9ad50cRevision changes
    • breaking

      removed the required property /// from the response with the status

    • info

      added the required property /// to the response with the status