Skip to content
MonetizeIt MonetizeIt Docs

Creates a new entitlement instance from an existing template.

POST
/api/v1/provision/admin/entitlements/templates/from-template
 
curl --request POST \
  --url https://example.com/api/v1/provision/admin/entitlements/templates/from-template \
  --header 'Content-Type: application/json' \
  --data '{ "entitlementTemplateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "fromEntitlementTemplateName": "example", "withEntitlementTemplateVersion": "example", "entitlementParameters": { "customerContactEmail": "example", "customerContactName": "example", "legalNoticeHtml": "example", "description": "example", "name": "example", "version": "example", "status": "example", "isTrial": true, "isTemplateForNewEntitlements": true, "customerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "orderId": "example", "reference": "example", "licenseKey": "example", "assignedPlanSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "assignedPlanName": "example", "externalReference": "example", "customerExternalReference": "example", "metadata": "example" }, "licenseActivationWorkflowParameters": { "requiredAuthenticationLevel": 1, "preAuthorizedDevices": [ "example" ], "fingerprint": "example", "maxDeviceActivations": 1, "useEntitlementMaxActivations": true, "activationCode": "example", "email": "example", "isTrialActivation": true, "requiresUserConsent": true, "sendUserNotification": true, "organizationGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "requiredUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "expirationTimeStamp": "2026-04-15T12:00:00Z" } }'

Request Body required

Section titled “Request Body required ”

Template id and target metadata for the new entitlement.

object
entitlementTemplateId
string format: uuid
fromEntitlementTemplateName
null | string
withEntitlementTemplateVersion
null | string
entitlementParameters
object
customerContactEmail
null | string
customerContactName
null | string
legalNoticeHtml
null | string
description
null | string
name
null | string
version
null | string
status
One of:
null
isTrial
null | boolean
isTemplateForNewEntitlements
null | boolean
customerId
null | string format: uuid
orderId
null | string
reference
null | string
licenseKey
null | string
assignedPlanSetId
null | string format: uuid
assignedPlanName
null | string
externalReference
null | string
customerExternalReference
null | string
metadata
null | object
licenseActivationWorkflowParameters
object
requiredAuthenticationLevel
integer
preAuthorizedDevices
Array<string> | null
fingerprint
null | string
maxDeviceActivations
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
useEntitlementMaxActivations
null | boolean
activationCode
null | string
email
null | string
isTrialActivation
null | boolean
requiresUserConsent
null | boolean
sendUserNotification
null | boolean
organizationGroupId
null | string format: uuid
requiredUserId
null | string format: uuid
expirationTimeStamp
null | string format: date-time
Example generated
{
  "entitlementTemplateId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "fromEntitlementTemplateName": "example",
  "withEntitlementTemplateVersion": "example",
  "entitlementParameters": {
    "customerContactEmail": "example",
    "customerContactName": "example",
    "legalNoticeHtml": "example",
    "description": "example",
    "name": "example",
    "version": "example",
    "status": "example",
    "isTrial": true,
    "isTemplateForNewEntitlements": true,
    "customerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "orderId": "example",
    "reference": "example",
    "licenseKey": "example",
    "assignedPlanSetId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "assignedPlanName": "example",
    "externalReference": "example",
    "customerExternalReference": "example",
    "metadata": "example"
  },
  "licenseActivationWorkflowParameters": {
    "requiredAuthenticationLevel": 1,
    "preAuthorizedDevices": [
      "example"
    ],
    "fingerprint": "example",
    "maxDeviceActivations": 1,
    "useEntitlementMaxActivations": true,
    "activationCode": "example",
    "email": "example",
    "isTrialActivation": true,
    "requiresUserConsent": true,
    "sendUserNotification": true,
    "organizationGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "requiredUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "expirationTimeStamp": "2026-04-15T12:00:00Z"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

400

Section titled “400 ”

Bad Request

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

401

Section titled “401 ”

Unauthorized

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

404

Section titled “404 ”

Not Found

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string