Overview of the Transactional Messaging Templates & Dynamic Content API
The Transactional Messaging Templates & Dynamic Content API allows you to manage your Transactional Messages and Dynamic Content:
- Create, edit, and delete Messages
- Create, edit, and delete Dynamic Content Blocks
- Add, edit, track, and untrack Message and Dynamic Content Block links
For further information on how to create, edit, and manage Transactional Messaging creatives, please consult the Actito User Guide or Actito Online Help.
The following methods are available:
Connection
Method Description Open Connection This method provides a session token when given valid credentials. Close Connection This method terminates the session token. Template Management
Method Description Create Template This method creates a Transactional Messaging Template. Create Template (POST) This method creates a Transactional Messaging Template. Delete Template This method deletes a Transactional Messaging Template. Update Template This method updates a Transactional Messaging Template. Update Template (POST) This method updates a Transactional Messaging Template. Clone Template This method clones a Transactional Messaging Template. Get Template This method retrieves a Transactional Messaging Template. Get Last Templates This method retrieves the most recently created Transactional Messaging Templates. Get Templates by Field This method retrieves a list of Transactional Messaging Templates containing a given value in a specified field. Get Templates by Period This method retrieves a list of Transactional Messaging Templates created during a specified period. Get Template Preview This method retrieves a preview of the HTML or text part of a Template without personalization. Create and Add a Standard Template Link This method creates and adds a standard link to the Template. Create and Add a Personalized Link This method creates and adds a personalized link to the Template. Update Template Link by Field This method updates a Template link by field. Delete a Template Link This method deletes a Template link. Track All Template Links This method activates link tracking for all links in a Template. Untrack All Template Links This method deactivates tracking for all the links in a Template. Track Template Link by Position This method activates link tracking for a link in a specific position in a Template. Untrack Template Link by Order This method deactivates link tracking for specific link by its order number. Get All Template Trackable Links This method retrieves a list of all the trackable links in a Template. Get All Template Tracked Links This method retrieves a list of all the tracked links in a Template. Get All Unused Template Tracked Links This method retrieves a list of all the unused tracked links in a Template. Get Default Senders This method retrieves the Transactional Messaging default sender. Get Non-Validated Senders This method retrieves the Transactional Messaging non-validated senders. Get Validated Senders This method retrieves the Transactional Messaging validated senders. Add This method adds a Dynamic Content Block to a Template. Dynamic Content Management
Method Description Create a This method creates a Dynamic Content Block. Update This method updates a Dynamic Content Block by field and value. Delete This method deletes a Dynamic Content Block. Clone This method clones a Dynamic Content Block. Get Dynamic Content Block This method retrieves a Dynamic Content Block using its ID. Get Last This method retrieves the most recently created Dynamic Content Blocks. Get by Field This method retrieves a list of Dynamic Content Blocks that contain the same given value in a specific field. Get by Period This method retrieves a list of Dynamic Content Blocks from a given period. Get Preview This method displays a preview of a Dynamic Content Block. Create and Add Standard Link This method creates and adds a standard link to the Dynamic Content Block. Create and Add Personalized Link This method creates and adds a personalized link to the Dynamic Content Block. Update Dynamic Content Block Link by Field This method updates a Dynamic Content Block link by field. Delete a Link This method deletes a Dynamic Content Block link. Track All Links This method activates tracking for all untracked Dynamic Content Block links and saves the Dynamic Content Block. Track Link by Position This method tracks the Dynamic Content Block link through its position in the Dynamic Content Block. Untrack All Links This method untracks all the Dynamic Content Block links. Untrack Link by Order This method untracks a link in the Dynamic Content Block by its order. Get Link by Order This method retrieves a Dynamic Content Block link by its order number. Get All Trackable Links This method retrieves a list of all the trackable links in a Dynamic Content Block. Get All Tracked Links This method retrieves a list of all the tracked links in a Dynamic Content Block. Get All Unused Dynamic Content Block Tracked Links This method retrieves a list of all the unused tracked links of the Dynamic Content Block.
Transactional Messaging Templates and Dynamic Content API Use Cases
Create a Dynamic Content Block and Add it to a Template
To create a Dynamic Content Block and add it to a Template, you would typically carry out the following procedure:
- Use the Open Connection method to open the connection.
- Use the Create Dynamic Content Block method to create the Dynamic Content Block.
- Use the Get Templates by Period method to retrieve a list of recently created Template and find the ID of the Template to which you want to add the Dynamic Content Block.
- Use the Add Dynamic Content Block method to add the Dynamic Content Block to the Template.
- Use the Close Connection method to close the connection.
Clone a Template and Update the New Template with a Different Dynamic Content Block
To add a different Dynamic Content Block to a Template:
- Use the Open Connection method to open the connection.
- Use the Get Templates by Period method to find the Template ID.
- Use the Clone Template method to clone the Template.
- Use the Get Dynamic Content Blocks by Period method to retrieve a list of recently created Dynamic Content Blocks and find the new Dynamic Content Block that you want to add.
- Use the Update Template method to add the new Dynamic Content Block to the Template.
- Use the Close Connection method to close the connection.