Updates an existing activation workflow.

PUT

/api/v1/provision/admin/entitlements/activation-workflow/{activationWorkflowId}

const url = 'https://example.com/api/v1/provision/admin/entitlements/activation-workflow/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","email":"example","activationRequiresValidDeviceId":true,"requiredUserId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","organizationGroupId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","activationCode":"example","fingerprint":"example","registeredFingerprints":["example"],"maxDeviceActivations":1,"userConsent":true,"requiresUserConsent":true,"sendUserNotification":true,"entitlementId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","activationTimeStamp":"2026-04-15T12:00:00Z","expirationTimeStamp":"2026-04-15T12:00:00Z","createdAt":"2026-04-15T12:00:00Z","verificationCodeUseCount":1,"maxVerificationCodeUseCount":1,"activationCodeUseCount":1,"maxActivationCodeUseCount":1,"isTrialActivation":true,"useEntitlementMaxActivations":true,"isDeleted":true,"requiredAuthenticationLevel":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/v1/provision/admin/entitlements/activation-workflow/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "email": "example", "activationRequiresValidDeviceId": true, "requiredUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "organizationGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "activationCode": "example", "fingerprint": "example", "registeredFingerprints": [ "example" ], "maxDeviceActivations": 1, "userConsent": true, "requiresUserConsent": true, "sendUserNotification": true, "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "activationTimeStamp": "2026-04-15T12:00:00Z", "expirationTimeStamp": "2026-04-15T12:00:00Z", "createdAt": "2026-04-15T12:00:00Z", "verificationCodeUseCount": 1, "maxVerificationCodeUseCount": 1, "activationCodeUseCount": 1, "maxActivationCodeUseCount": 1, "isTrialActivation": true, "useEntitlementMaxActivations": true, "isDeleted": true, "requiredAuthenticationLevel": 1 }'

Parameters

Path Parameters

activationWorkflowId

required

string format: uuid

Activation workflow id.

Request Body^required

Updated workflow payload.

object

string format: uuid

email

string

activationRequiresValidDeviceId

boolean

requiredUserId

string format: uuid

organizationGroupId

string format: uuid

activationCode

string

fingerprint

string

registeredFingerprints

Array<string>

maxDeviceActivations

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

userConsent

boolean

requiresUserConsent

boolean

sendUserNotification

boolean

entitlementId

string format: uuid

activationTimeStamp

string format: date-time

expirationTimeStamp

string format: date-time

createdAt

string format: date-time

verificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxVerificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

activationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxActivationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isTrialActivation

boolean

useEntitlementMaxActivations

boolean

isDeleted

boolean

requiredAuthenticationLevel

integer

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "email": "example",
  "activationRequiresValidDeviceId": true,
  "requiredUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "organizationGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "activationCode": "example",
  "fingerprint": "example",
  "registeredFingerprints": [
    "example"
  ],
  "maxDeviceActivations": 1,
  "userConsent": true,
  "requiresUserConsent": true,
  "sendUserNotification": true,
  "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "activationTimeStamp": "2026-04-15T12:00:00Z",
  "expirationTimeStamp": "2026-04-15T12:00:00Z",
  "createdAt": "2026-04-15T12:00:00Z",
  "verificationCodeUseCount": 1,
  "maxVerificationCodeUseCount": 1,
  "activationCodeUseCount": 1,
  "maxActivationCodeUseCount": 1,
  "isTrialActivation": true,
  "useEntitlementMaxActivations": true,
  "isDeleted": true,
  "requiredAuthenticationLevel": 1
}

object

string format: uuid

email

string

activationRequiresValidDeviceId

boolean

requiredUserId

string format: uuid

organizationGroupId

string format: uuid

activationCode

string

fingerprint

string

registeredFingerprints

Array<string>

maxDeviceActivations

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

userConsent

boolean

requiresUserConsent

boolean

sendUserNotification

boolean

entitlementId

string format: uuid

activationTimeStamp

string format: date-time

expirationTimeStamp

string format: date-time

createdAt

string format: date-time

verificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxVerificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

activationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxActivationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isTrialActivation

boolean

useEntitlementMaxActivations

boolean

isDeleted

boolean

requiredAuthenticationLevel

integer

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "email": "example",
  "activationRequiresValidDeviceId": true,
  "requiredUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "organizationGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "activationCode": "example",
  "fingerprint": "example",
  "registeredFingerprints": [
    "example"
  ],
  "maxDeviceActivations": 1,
  "userConsent": true,
  "requiresUserConsent": true,
  "sendUserNotification": true,
  "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "activationTimeStamp": "2026-04-15T12:00:00Z",
  "expirationTimeStamp": "2026-04-15T12:00:00Z",
  "createdAt": "2026-04-15T12:00:00Z",
  "verificationCodeUseCount": 1,
  "maxVerificationCodeUseCount": 1,
  "activationCodeUseCount": 1,
  "maxActivationCodeUseCount": 1,
  "isTrialActivation": true,
  "useEntitlementMaxActivations": true,
  "isDeleted": true,
  "requiredAuthenticationLevel": 1
}

object

string format: uuid

email

string

activationRequiresValidDeviceId

boolean

requiredUserId

string format: uuid

organizationGroupId

string format: uuid

activationCode

string

fingerprint

string

registeredFingerprints

Array<string>

maxDeviceActivations

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

userConsent

boolean

requiresUserConsent

boolean

sendUserNotification

boolean

entitlementId

string format: uuid

activationTimeStamp

string format: date-time

expirationTimeStamp

string format: date-time

createdAt

string format: date-time

verificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxVerificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

activationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxActivationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isTrialActivation

boolean

useEntitlementMaxActivations

boolean

isDeleted

boolean

requiredAuthenticationLevel

integer

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "email": "example",
  "activationRequiresValidDeviceId": true,
  "requiredUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "organizationGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "activationCode": "example",
  "fingerprint": "example",
  "registeredFingerprints": [
    "example"
  ],
  "maxDeviceActivations": 1,
  "userConsent": true,
  "requiresUserConsent": true,
  "sendUserNotification": true,
  "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "activationTimeStamp": "2026-04-15T12:00:00Z",
  "expirationTimeStamp": "2026-04-15T12:00:00Z",
  "createdAt": "2026-04-15T12:00:00Z",
  "verificationCodeUseCount": 1,
  "maxVerificationCodeUseCount": 1,
  "activationCodeUseCount": 1,
  "maxActivationCodeUseCount": 1,
  "isTrialActivation": true,
  "useEntitlementMaxActivations": true,
  "isDeleted": true,
  "requiredAuthenticationLevel": 1
}

Responses

200

object

string format: uuid

email

string

activationRequiresValidDeviceId

boolean

requiredUserId

string format: uuid

organizationGroupId

string format: uuid

activationCode

string

fingerprint

string

registeredFingerprints

Array<string>

maxDeviceActivations

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

userConsent

boolean

requiresUserConsent

boolean

sendUserNotification

boolean

entitlementId

string format: uuid

activationTimeStamp

string format: date-time

expirationTimeStamp

string format: date-time

createdAt

string format: date-time

verificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxVerificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

activationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxActivationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isTrialActivation

boolean

useEntitlementMaxActivations

boolean

isDeleted

boolean

requiredAuthenticationLevel

integer

object

string format: uuid

email

string

activationRequiresValidDeviceId

boolean

requiredUserId

string format: uuid

organizationGroupId

string format: uuid

activationCode

string

fingerprint

string

registeredFingerprints

Array<string>

maxDeviceActivations

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

userConsent

boolean

requiresUserConsent

boolean

sendUserNotification

boolean

entitlementId

string format: uuid

activationTimeStamp

string format: date-time

expirationTimeStamp

string format: date-time

createdAt

string format: date-time

verificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxVerificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

activationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxActivationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isTrialActivation

boolean

useEntitlementMaxActivations

boolean

isDeleted

boolean

requiredAuthenticationLevel

integer

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "email": "example",
  "activationRequiresValidDeviceId": true,
  "requiredUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "organizationGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "activationCode": "example",
  "fingerprint": "example",
  "registeredFingerprints": [
    "example"
  ],
  "maxDeviceActivations": 1,
  "userConsent": true,
  "requiresUserConsent": true,
  "sendUserNotification": true,
  "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "activationTimeStamp": "2026-04-15T12:00:00Z",
  "expirationTimeStamp": "2026-04-15T12:00:00Z",
  "createdAt": "2026-04-15T12:00:00Z",
  "verificationCodeUseCount": 1,
  "maxVerificationCodeUseCount": 1,
  "activationCodeUseCount": 1,
  "maxActivationCodeUseCount": 1,
  "isTrialActivation": true,
  "useEntitlementMaxActivations": true,
  "isDeleted": true,
  "requiredAuthenticationLevel": 1
}

object

string format: uuid

email

string

activationRequiresValidDeviceId

boolean

requiredUserId

string format: uuid

organizationGroupId

string format: uuid

activationCode

string

fingerprint

string

registeredFingerprints

Array<string>

maxDeviceActivations

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

userConsent

boolean

requiresUserConsent

boolean

sendUserNotification

boolean

entitlementId

string format: uuid

activationTimeStamp

string format: date-time

expirationTimeStamp

string format: date-time

createdAt

string format: date-time

verificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxVerificationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

activationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

maxActivationCodeUseCount

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

isTrialActivation

boolean

useEntitlementMaxActivations

boolean

isDeleted

boolean

requiredAuthenticationLevel

integer

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "email": "example",
  "activationRequiresValidDeviceId": true,
  "requiredUserId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "organizationGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "activationCode": "example",
  "fingerprint": "example",
  "registeredFingerprints": [
    "example"
  ],
  "maxDeviceActivations": 1,
  "userConsent": true,
  "requiresUserConsent": true,
  "sendUserNotification": true,
  "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "activationTimeStamp": "2026-04-15T12:00:00Z",
  "expirationTimeStamp": "2026-04-15T12:00:00Z",
  "createdAt": "2026-04-15T12:00:00Z",
  "verificationCodeUseCount": 1,
  "maxVerificationCodeUseCount": 1,
  "activationCodeUseCount": 1,
  "maxActivationCodeUseCount": 1,
  "isTrialActivation": true,
  "useEntitlementMaxActivations": true,
  "isDeleted": true,
  "requiredAuthenticationLevel": 1
}

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

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

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

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

Updates an existing activation workflow.

Parameters

Path Parameters

Request Body required

Example generated

Example generated

Example generated

Responses

200

Example generated

Example generated

400

Example generated

Example generated

404

Example generated

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated