Sign in
Entitlements V2

Update Entitlement

Updates an entitlement's name, description, products, or metadata. Requires entitlements:write scope.

patch/v2/entitlements/{id}

Path parameters

idstring required

Entitlement ID

Entitlement ID

Request body

identifierstring

Unique identifier string for the entitlement

namestring

Display name of the entitlement

descriptionstring

Description of the entitlement

productsstring[]

List of product IDs that grant this entitlement

metadataobject

Arbitrary key-value metadata to attach to the entitlement

Response

Success

idstring required

Unique identifier for the entitlement

object'entitlement' required

Object type, always entitlement

project_idstring required

ID of the project this entitlement belongs to

application_idstring required

ID of the application that owns this entitlement

identifierstring required

Unique identifier string for the entitlement

namestring nullable required

Display name of the entitlement, or null

descriptionstring nullable required

Description of the entitlement, or null

productsstring[] required

List of product IDs that grant this entitlement

metadataobject required
created_atstring required

ISO 8601 timestamp of when the entitlement was created

updated_atstring required

ISO 8601 timestamp of when the entitlement was last updated

Changes