Patch an entitlement

PATCH 
/entitlements/v1/:id

This API updates an existing entitlement using JSON Patch syntax.

The following fields are patchable: requestable, segments, privilegeOverride/level, owner, name, description, manuallyUpdatedFields, and accessModelMetadata

When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.

When you're patching accessModelMetadata, each attribute's key must match the key of an existing access model metadata attribute, and each value must be one of the values configured for that key. Use List access model metadata attributes to look up the available keys and values.

Request

Responses

200

Responds with the entitlement as updated.

400

Client Error - Returned if the request body is invalid.

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

404

Not Found - returned if the request URL refers to a resource or object that does not exist

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

500

Internal Server Error - Returned if there is an unexpected error.