EntitlementsTemplate

Deactivate entitlements template

Deactivates (tombstones) an entitlements template. Regulated users can only deactivate regulated and customer templates. The template will no longer be available for assignment but existing references are preserved.

Required entitlement: regulated.templates.canEditEntitlementTemplate
Entitles the regulated user to create, update, and manage entitlements templates for their regulated entity

delete/api-regulated/v1/entitlements-templates/{id}

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/entitlements-templates/{id}
  • Auth: OAuth 2 (implicit, authorization URL https://auth.currencyguard.com/oauth2/authorize, scopes: regulated.templates.canEditEntitlementTemplate)

Path parameters

idstring uuid required

Response

Template deactivated successfully

idstring uuid

The unique identifier for the entitlements template.

templateNamestring

The unique name of the entitlements template.

descriptionstring

Description of what this template provides.

userType'INTERNAL' | 'REGULATED' | 'CUSTOMER' | 'SALES'

The user type this template applies to.

isActiveboolean

Whether this template is active and can be assigned to users.

versionNumberinteger

The strictly monotonically increasing version number for this record.

updatedBystring

The username of the person or entity that updated this record.

updatedAtstring

The timestamp of the last update in UTC.

createdAtstring

The timestamp of creation in UTC.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "templateName": "Super User",
  "description": "Full administrative access with all permissions",
  "userType": "REGULATED",
  "isActive": true,
  "versionNumber": 1,
  "updatedBy": "jbloggs24",
  "updatedAt": "2024-10-18T12:30:40Z",
  "createdAt": "2024-10-18T12:30:40Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.