Zentitle2 by Nalpeiron Integrations

Activate entitlement for provided seat id and create activation that can be used feature management This method will work only when entitlement was created before create activation is called.

Creates new customer

This method allows to request setup password or reset password for selected contact. If the contact does not have credentials set up, the action will return an error. If the action is "setup", the contact will receive an email with a link to set the password unless the contact already has a password, the request will return error. If the action is "reset", the contact will receive an email with a link to reset the password unless the contact does not have a password set, the request will return error.

Creates new product edition

Create an entitlement group providing a list of product SKUs. For each SKU provided an entitlement will be created within the entitlement group. All other parameters are optional. Activation code is also optional, and if not provided, it will be generated automatically. If 3rd party activation code source is used, it should be provided on this call. This call will create an entitlement group what will contain one or more entitlements that is defined by offering specification.

Extend an existing entitlement group by adding new entitlements based on the provided SKUs. This will add additional entitlements to the existing entitlement group.

Creates new entitlement note

Creates new offering

Creates a new product with default settings

Create new product feature. Value defined for this feature can be overridden in each edition if required.

This method returns amount of feature. Only element pool features are allowed to be returned

This method disables customer and it's entitlements.

This method updates the selected customer contact details. At least one property must be provided.

This method allows to change value of selected attribute for specific edition. This method can be used to override default value of global and products attributes.

This method change state of entitlement that seats can be activated. Depending of offering configuration entitlement can be activated during entitlement creation

This method disables entitlement. Disabled entitlement cannot be activated.

Renews a subscription entitlement. This method is specially designed for renewal of previously activated subscription entitlements. The new expiry date is determined using following rules: * If the expiration date has passed but the grace period is active, the new expiry date will be calculated by adding the subscription period to the current expiry date. * If the grace period has either expired or not defined at all, the expiry date will be computed by adding the subscription period to the current date. * If the expiry date is still in the future, the new expiry date will be determined by adding the subscription period to the current expiry date. This method also resets all usage count feature usage at the beginning of the new subscription period.

This method allows to reset entitlement overrides to match current product configuration. Each field can be reset individually by setting corresponding field to true. This method can also to restore current configuration for features and attributes by sending appropriate keys literals in features and attributes arrays. If any of requested fields was not overridden but current product configuration is different from default it still will be updated with current value from product configuration. If reset seatCount or overdraftSeatLimit fields where used and current product configuration results in lower seat count than seats currently used in entitlement it will fail unless forceSeatCount query string parameter is set to true.

This method will add activation codes to the entitlement group.

This method will remove activation codes from the entitlement group.

This method allows updating selected product properties. At least one property has to be provided, otherwise the request will be rejected.

Finds an attribute.

Finds customers.

Finds customer contacts.

Finds customer contact searchs.

Finds customer notes.

Finds an entitlement.

Finds an entitlement activation.

Finds entitlement activations logs.

Finds entitlement groups.

Finds an entitlement note.

Finds a feature.

Finds offerings.

Finds plans.

Finds products.

Finds product attributes.

Finds product editions.

Finds product edition attributes.

Finds product edition features.

Finds product features.

Create a global attribute that will be included in all entitlements. Default value can be overridden in product or edition level.

This method creates a new customer contact. The contact must have a unique email address for the customer.

Creates new customer note

This method triggers provision webhook event for the entitlement

This method assigns a contact (with ABL credentials) to the entitlement group. If contact is already part of the entitlement group, the request will be ignored and complete successfully. Adding a contact which does not have ABL credentials will result in an error.

This endpoint looks up an entitlement group using an activation code and product identifier.

Create a global feature that will be included in all entitlements. Default value can be overridden in product or edition level.

Creates new plan

Create new product attribute. Value defined for this attribute can be overridden in each edition if required.

This method checkouts some amount feature. Feature can be used permanently (usage count) or can be returned (element pool) using return feature method.

Refresh lease time of provided seat activation When activation lease expiry already equals entitlement expiry, next and any subsequent refreshes will fail since the activation cannot be extended beyond the entitlement expiry.

This method re-enables customer and it's entitlements.

Creates or updates credentials for a contact. Two types of authentication are supported: password and OpenID. When using OpenID authentication, the unique claim value is required. When using password, email will be sent to the contact's email with a link to set the password. Email must be unique across the system, so if the email is already in use, the operation will fail.

Allows to change settings of selected entitlement, including attributes and features. Only provided features and attributes will be processed. If the caller has no intentions to update features or attributes those field can be sent as null and all values will remain intact

This method allows the change of an entitlement offering. This method can only modify the entitlement to a different offering if the new offering belongs to the same product. If the new offering has a lower seat count than the seats currently used in the entitlement, it will fail unless the 'forceSeatCount' query string parameter is set to true. If the seat count or overdraft settings were manually edited before, they will not be changed by this method. This method will also update all entitlement features and attributes to match the new offering, unless they were previously changed. All usage count feature usages will be reset. If the entitlement has not been activated yet and the offering has been configured to activate the entitlement upon creation, it will be applied by this method. For subscription offerings, it will also update the entitlement expiry date to match the new offering, starting from the current date.

This method re-enables entitlement. Enabled entitlement can be used normally.

Only usage count features can be reset

Entitlement group update

This method will generate new codes and add them to the entitlement group.

This method allows changing selected offering attributes without providing the full payload.

This method can be used to change value of selected product attribute. This method can be used to override default value of global attributes for each product separately.

Finds a customer.

Finds a customer contact.

Finds a customer contact credential.

Finds a customer note.

Finds customer stats.

Finds entitlements.

Finds entitlement activations.

Finds an entitlement group.

Finds entitlement group authorized contacts.

Finds entitlement notes.

Finds an offering.

Finds a plan.

Finds a product.

Finds a product attribute.

Finds a product edition.

Finds a product edition attribute.

Finds a product edition feature.

Finds a product feature.