Manage Zentitle2 and Zengain customers, contacts, entitlements, activations, products, offerings and webhooks through the Nalpeiron Management API.
Explore 109 workflow actions for Nalpeiron (Zentitle2, Zengain), including account permissions and operation limits.
51 read actions58 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Activate entitlement
Write
This method change state of entitlement that seats can be activated.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Assign contact to entitlement group
Write
This method assigns a contact (with ABL credentials) to the entitlement group.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Change entitlement offering
Write
This method allows the change of an entitlement offering.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Checkout activation feature
Write
This method checkouts some amount feature.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create activation
Write
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.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create an entitlement group
Write
Create an entitlement group providing a list of product SKUs.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create custom field
Write
Creates new custom field.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create customer
Write
Creates new customer
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create customer contact
Write
This method creates a new customer contact.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create customer note
Write
Creates new customer note
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create edition
Write
Creates new product edition
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create entitlement note
Write
Creates new entitlement note
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create global attribute
Write
Create a global attribute that will be included in all entitlements.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create global feature
Write
Create a global feature that will be included in all entitlements.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create offering
Write
Creates new offering
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create plan
Write
Creates new plan
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create product
Write
Creates a new product with default settings
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create product attribute
Write
Create new product attribute.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create product feature
Write
Create new product feature.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Create webhook
Write
Creates tenant webhook
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete activation
Write
Delete activation on connected entitlement.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete edition attribute
Write
This method removes attribute value defined in edition level, falling back to value defined on higher level.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete edition feature
Write
This method removes feature value defined in edition level, falling back to value defined on higher level.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete webhook
Write
Deletes account webhook
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Disable customer
Write
This method disables customer and it's entitlements.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Disable entitlement
Write
This method disables entitlement.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Enable customer
Write
This method re-enables customer and it's entitlements.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Enable entitlement
Write
This method re-enables entitlement.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Extend entitlement group
Write
Extend an existing entitlement group by adding new entitlements based on the provided SKUs.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get a customer contact list
Read
This method returns a list of customer contacts.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get a product list
Read
This method returns a list of products that can be filtered by following query parameters
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get activation state
Read
This method returns activation details including information about attributes and available features
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get an entitlement group
Read
This method returns entitlement group details.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get custom field
Read
This method returns selected custom field
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get custom field list
Read
This method returns list of all custom fields
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get custom field list by entity type
Read
This method returns list of custom fields for selected entity type
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get customer
Read
This method returns the selected customer
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get customer contact
Read
This method returns selected customer contact details.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get customer list
Read
This method returns list of customers
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get customer note
Read
This method returns customer note
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get customer note list
Read
This method returns list of customer notes
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get customer zentitle statistic
Read
Return zentitle statistic for a given customer
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get edition
Read
This method returns product edition details
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get edition attribute
Read
This method returns selected attribute with value defined in edition level (in case of override).
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get edition attribute by key
Read
Returns a single attribute for the selected edition by its unique key.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get edition attributes list
Read
This method returns list of all attributes for selected edition.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get edition feature
Read
This method returns selected feature with value defined in edition level (in case of override).
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get edition feature list
Read
This method returns list of all features for selected edition.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get edition list
Read
This method returns list of editions that can be filtered by following query parameters
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get entitlement
Read
This method returns entitlement details
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get entitlement group authorized contacts
Read
This method returns list of contacts (with ABL credentials) authorized for the entitlement group.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get entitlement group list
Read
This method returns entitlement group list.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get entitlement list
Read
This method returns list of entitlements that can be filtered by following query parameters
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get entitlement note
Read
This method returns entitlement note
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get entitlement note list
Read
This method returns list of entitlement notes
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get global attribute
Read
This method returns selected global attribute
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get global attribute by key
Read
Returns a single global attribute by its unique key.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get global attributes list
Read
This method returns list of all attributes
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get global feature
Read
This method returns selected global feature
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get global features list
Read
This method returns list of all global features
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get list of webhooks
Read
Returns list of account webhooks
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get Local License Server
Read
This method returns Local License Server details
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get local license servers list
Read
Returns list of all available local license servers
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get offering
Read
This method returns offering details
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get offering list
Read
This method returns list of offering that can be filtered by the following query parameters
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get plan
Read
This method returns plan details
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get plan list
Read
This method returns list of plans that can be filtered by following query parameters
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get product
Read
This method returns product details
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get product attribute
Read
This method returns selected attribute.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get product attribute by key
Read
Returns a single attribute for the selected product by its unique key.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get product attributes list
Read
This method returns list of all attributes for selected product.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get product feature
Read
This method returns selected feature.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get product features list
Read
This method returns list of all features for selected product.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get public part of the asymmetric key
Read
Get public part of the asymmetric key
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get security settings
Read
Gets Security Settings
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get webhook
Read
Get account webhook by webhookId
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Get webhook events list
Read
Returns list of all available events
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
List of entitlement activations
Read
This method returns list of entitlement activation that can be filtered by following query parameters
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Log of activations activity
Read
This method returns log of activations activity on the entitlement
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Patch customer contact
Write
This method updates the selected customer contact details.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch offering
Write
This method allows changing selected offering attributes without providing the full payload.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Patch product
Write
This method allows updating selected product properties.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Refresh activation
Write
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.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Remove contact from entitlement group
Write
This method will remove contact from the entitlement group authorized contacts.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Renew entitlement
Write
Renews a subscription entitlement.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reset entitlement overrides
Write
This method allows to reset entitlement overrides to match current product configuration.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reset provision status
Write
This method resets provision date for the entitlement
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Reset usage count of a feature
Write
Only usage count features can be reset
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Return activation feature
Write
This method returns amount of feature.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Search contacts
Read
This method search for customer contacts by email and returns paginated list of matching contacts.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
Test webhook listener
Write
Sends a test event to webhook URL
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Trigger provision event
Write
This method triggers provision webhook event for the entitlement
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update custom field
Write
This method updates selected custom field
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update customer
Write
This method allows to change settings of selected customer
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update customer contact
Write
This method updates all customer contact details.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update edition attribute
Write
This method allows to change value of selected attribute for specific edition.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update edition feature
Write
This method allows to change value of selected feature for specific edition.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update entitlement
Write
Allows to change settings of selected entitlement, including attributes and features.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update entitlement group
Write
Entitlement group update
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update global attribute definition
Write
This method allows to change settings of selected global attribute
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update global feature
Write
This method allows to change settings of selected global feature
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update offering
Write
This method allows changing settings of the selected offering
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update plan
Write
This method allows to change settings of selected plan
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update product
Write
This method allows changing settings of the selected product
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update product attribute
Write
This method allows to change settings of selected product attribute.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update product attribute value
Write
This method can be used to change value of selected product attribute.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update product edition
Write
This method allows to change settings of selected edition
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update product feature
Write
This method allows to change settings of selected feature.
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
Update webhook
Write
Updates account webhook
Permissions and limits
Account permissions
A Zentitle2 Management API client (Administration, API Credentials) with the roles the call needs
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Nalpeiron (Zentitle2, Zengain). A saved workflow is not a completed provider action.
Developer ยท CONNECTION
