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
}
'import requests
url = "https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id}"
payload = {
"name": "Premium Access",
"code": "PREMIUM_ACCESS",
"description": "Grants access to premium features",
"reportable": True
}
headers = {
"x-admin-api-key": "<x-admin-api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-admin-api-key': '<x-admin-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Premium Access',
code: 'PREMIUM_ACCESS',
description: 'Grants access to premium features',
reportable: true
})
};
fetch('https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Premium Access',
'code' => 'PREMIUM_ACCESS',
'description' => 'Grants access to premium features',
'reportable' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-admin-api-key: <x-admin-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id}"
payload := strings.NewReader("{\n \"name\": \"Premium Access\",\n \"code\": \"PREMIUM_ACCESS\",\n \"description\": \"Grants access to premium features\",\n \"reportable\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-admin-api-key", "<x-admin-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id}")
.header("x-admin-api-key", "<x-admin-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Premium Access\",\n \"code\": \"PREMIUM_ACCESS\",\n \"description\": \"Grants access to premium features\",\n \"reportable\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-admin-api-key"] = '<x-admin-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Premium Access\",\n \"code\": \"PREMIUM_ACCESS\",\n \"description\": \"Grants access to premium features\",\n \"reportable\": true\n}"
response = http.request(request)
puts response.read_bodyEntitlements
Update an entitlement
Updates an existing entitlement definition
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
}
'import requests
url = "https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id}"
payload = {
"name": "Premium Access",
"code": "PREMIUM_ACCESS",
"description": "Grants access to premium features",
"reportable": True
}
headers = {
"x-admin-api-key": "<x-admin-api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-admin-api-key': '<x-admin-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Premium Access',
code: 'PREMIUM_ACCESS',
description: 'Grants access to premium features',
reportable: true
})
};
fetch('https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Premium Access',
'code' => 'PREMIUM_ACCESS',
'description' => 'Grants access to premium features',
'reportable' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-admin-api-key: <x-admin-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id}"
payload := strings.NewReader("{\n \"name\": \"Premium Access\",\n \"code\": \"PREMIUM_ACCESS\",\n \"description\": \"Grants access to premium features\",\n \"reportable\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-admin-api-key", "<x-admin-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id}")
.header("x-admin-api-key", "<x-admin-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Premium Access\",\n \"code\": \"PREMIUM_ACCESS\",\n \"description\": \"Grants access to premium features\",\n \"reportable\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev-entitlements-api.iqraa.ai/api/v1/api/v1/entitlements/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-admin-api-key"] = '<x-admin-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Premium Access\",\n \"code\": \"PREMIUM_ACCESS\",\n \"description\": \"Grants access to premium features\",\n \"reportable\": true\n}"
response = http.request(request)
puts response.read_bodyHeaders
The API key to access the admin API
Path Parameters
Entitlement ID
Body
application/json
The name of the entitlement
Example:
"Premium Access"
The unique code for the entitlement
Example:
"PREMIUM_ACCESS"
A description of the entitlement
Example:
"Grants access to premium features"
Whether the entitlement is reportable
Example:
true
Response
Entitlement updated successfully
⌘I