The APIs

The SessionM Platform provides a set of APIs that make programmatic access to that data possible. It offers services for several types of key, cloud-based marketing data. The APIs themselves are organized into groupings that reflect the primary functions of the system.

The Customers grouping is a collection of APIs that support foundational types of customer data with operations that manage customer profile data with Standard and Custom Profile APIs. These APIs offer services for building hierarchies of related customers (Customer Affiliation API), as well as services for merging customer accounts (Customer Accounts Merge API) or maintaining notes on active customer accounts (Customer Account Notes API). The Tags API supports the classification of customers with audience segmentation tags. Each segment can be associated with a variety of rule types, including targeting rules. Tags can be attached to customers, acting as keyword classifiers.

Perhaps most importantly, the Customers grouping provides APIs that handle the events customers generate with an Events API and several Timeline APIs for event streams. The platform's real-time rules engine listens for customer events from a variety of sources. You can define customer actions using these events and their metadata, and then set rules against them to trigger real-time, personalized outcomes. Rules can be set against general, non-transactional engagement actions, like opening an email. If you want to build rules that send purchase-related engagement data, see the SendTransaction API. Engagement with customers can also be driven from planned marketing campaigns.

This grouping also offers an SMS verification API for sending a Short Message Service (SMS) message to a customer in the form of a link to follow or an activation code to apply. In addition, there is an API for managing customer data privacy requests (Data Privacy API), which can include requests to forget or export personal data as well as restrict customers from or reinstate customers to loyalty and marketing programs. And, finally, the collection contains the Device Tokens API which register and de-register device tokens that enable SessionM to send mobile push notifications to customers using third-party APIs.

The Campaigns grouping represents scheduled and targeted customer engagement of any kind, including promotions, displaying content, and personalized messaging. The grouping includes APIs that manage campaigns at a basic level (Campaigns API). It also includes the Inbox API for sending and managing application inbox notifications for specific customers participating in campaigns or for an organization as a whole. Finally, the Promo Code APIs support customer loyalty programs that use promo codes. The platform can generate codes for customers so they can claim them for incentives. Note that the bulk of the platform's loyalty API documentation resides in the Swagger libraries for the Offers, Incentives, Catalog and Transactions domains. For more information, consult your SessionM customer success contact.

The SessionM Platform offers the Advanced grouping for APIs and procedures that support some complex and generally less common implementation goals. For example, the Divisions API retrieves an organization management configuration for a SessionM tenant. The Lockout and Limiter APIs can be used to develop logic that controls customers' ability to claim promo codes based on their past activity. In addition, the grouping offers the Model API for retrieving the customer model defined for a specific organization.

Finally, the Deprecated grouping houses any API that has been deprecated in favor of newer API versions. These APIs, however, are being supported for legacy implementations.