HCL SW Blogs
Select Page


Campaign Offer APIs
In the upcoming Campaign version, a new powerful feature has been added: the ability to perform common tasks through REST APIs! 

​Let’s explain first what the RESTful approach is that we have used to create this new functionality. 

Representational state transfer (REST) or RESTful Web Services is a way of providing interoperability between computer systems on the Internet. REST-compliant Web Services allow requesting systems to access and manipulate textual representations of Web resources using a uniform and predefined set of stateless operations.  
REST APIs give you the possibility to perform actions and queries on your offers, such as: 

  • Retrieve useful data from your Offer information (query Operations and Applications, optionally using specific filters to narrow down your queries)
  • Retrieve all offers
  • Create new offers
  • Perform changes in Offer details
  • Get Offer codes
  • Retire Offers
  • Search for Offers
  • Get Offer template details from which the offer is create
  • Validate Offers

All this can be performed in a simple, safe, and quick way by using REST APIs. 

Simple: REST APIs are simple to use, requiring just a URL and few parameters as input.

Safe: leveraging an HTTPS connection and basic authentication, all your data is protected when sent and received.

Quick: response time of a REST API call is in seconds!
The Campaign installation will have the Swagger documentation for the precise information for using each API and JSON payload samples.

​It can be found in our documentation.

Sumitra Chachar

   Sumitra Chachar
   Product Manager – HCL Marketing Suite

Sumitra is a Product Manager for HCL Marketing Suite (formerly known as Unica). She has been part of Marketing Suite since 2007. She comes from technical background and has passion for building great products.
Marketing Platform, Campaign, Interact, Marketing Operations, Contact Optimization, and Opportunity Detect are trademarks of IBM Corporation, in at least one jurisdiction, and are used under license. 
Comment wrap
Further Reading
Campaign Outbound Triggers
Marketing & Commerce | September 6, 2018
Using Campaign Outbound Triggers
An outbound trigger is the execution of a command, batch file, or script (that is stored on the Campaign Application Server) that takes place after a flowchart or process is run. You can define triggers to perform virtually any action, such as opening an application, sending an email, or running a program.
always on marketing
Uncategorized | July 25, 2018
Always-On Marketing
When was the last time you decided that you needed a product or service but really had no idea from where to get it?
Campaign Execution Best Practices
Marketing & Commerce | July 11, 2018
Campaign Execution Best Practices
  The Campaign is the most used tool and the backbone of your marketing ecosystem. Here are the best practice recommended for Campaign users after years of working with this engine. Incorporate the 4 principles of Best Practices into your group Reuse, Organize, Automate and Share. ​ Execution specific Best Practices Create derived fields or custom macros when you need an aggregation of data that doesn’t exist currently on the database. Create control groups at the lowest level of segmentation, and use the random selection functionality provided in the software. When building a new campaign meet as a group and brainstorm the new design before building it.  Then after the campaign is built, meet again as a group to review the design and evaluate the campaign from all three vantage points: Performance, Ease-Of-Use, and Flexibility. Define offer and promotion history so that each discreet contact with a customer can be identified in the database. Use Campaign user attributes to capture more information or create derived fields to support this requirement. Use ‘Check Syntax’ for syntax checking at all times. Use the ‘Summary Tab’ to capture Campaign metadata and descriptive information. Apply suppressions early in the Campaign design process (so that your surviving population is smaller as you progress down the processing chain). To obtain waterfall or cascading counts, use a separate process box for each Select or Segment process, the results can then be displayed with the cell waterfall report. Use the ‘Cell Size Limit’ function to limit output records to particular channels based on constraints. When entering multiple conditions in SELECT and SEGMENT process boxes, enter criteria piece per line and place the AND/OR operators on a separate/newline.  Enter the AND/OR operators in ALL CAPS. Use the ‘General Tab’ to capture comments about the processes you have created. When creating multiple...
Filters result by