Skip to main content
PATCH
/
api
/
v1
/
entitlements
/
{id}
Update an entitlement
curl --request PATCH \
  --url https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-admin-api-key: <x-admin-api-key>' \
  --data '
{
  "name": "Premium Access",
  "code": "PREMIUM_ACCESS",
  "description": "Grants access to premium features",
  "reportable": true
}
'

Headers

​
x-admin-api-key
string
required

The API key to access the admin API

Path Parameters

​
id
string
required

Entitlement ID

Body

application/json
​
name
string

The name of the entitlement

Example:

"Premium Access"

​
code
string

The unique code for the entitlement

Example:

"PREMIUM_ACCESS"

​
description
string

A description of the entitlement

Example:

"Grants access to premium features"

​
reportable
boolean
default:false

Whether the entitlement is reportable

Example:

true

Response

Entitlement updated successfully