v57

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-07-2161198428.4 KB
Omni AI

Create Entitlements

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

post/v1/omni-ai/entitlements

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"
  }
}