About Entities API

Entities APIs manage the creation, expansion, and customization of entities within Antavo. An entity is a generic model representing various types of data objects, such as customers, products, or rewards. The endpoints provided in this documentation demonstrate how entity API calls work.

Currently, it is possible to expand entities, and other entities may become available upon module activation.

The API endpoints require the Custom entities module to be enabled in the Management UI, and the corresponding custom entities must also be activated. Entity attributes must be tagged as searchable to be used as additional parameters. API requests can be submitted and processed with null attributes.

Supported Entities and Actions

Below is the current list of Antavo entities, their associated modules, and supported actions:

Associated module/Core feature	Entity module name `{module}`	Entity name `{entity}`	Create	Read	Update	Delete
Custom entities	`custom`	`{unique id of the custom entity}`	✅	✅	✅	✅
Challenges	`challenges`	`challenge`	✅	✅	✅	✅
Contest lite	`contests`	`contest`	❌	✅	❌	❌
Coupons	`coupons`	`pool`	❌	✅	❌	❌
Core feature	`core`	`transaction`	✅	✅	❌	❌
Core feature	`core`	`customer`	✅	✅	✅	✅
Customer lists	`core`	`customer-list`	✅	✅	✅	✅
Gamified profiling	`profiling`	`flow`	❌	✅	❌	❌
Loyalty cards	`cards`	`card`	✅	✅	✅	❌
Offers	`offers`	`offer`	❌	✅	❌	❌
Points economy	`accounts`	`account`	❌	✅	❌	❌
Prize wheels	`prize-wheels`	`wheel`	❌	✅	❌	✅
Product catalog	`products`	`product`	✅	✅	✅	❌
Rewards	`rewards`	`reward`	✅	✅	✅	✅
Reward categories	not available	not available	❌	❌	❌	❌
Stores	`stores`	`store`	✅	✅	✅	✅
Tiers	`tiers`	`tier`	❌	✅	❌	❌

Endpoint Overview

Generic: Provides basic operations for creating, reading, updating, and deleting entities.
Rewards: Manages reward entities, including creating, reading, updating, and deleting rewards.
Customer lists: Handles customer list entities, allowing for the creation, retrieval, updating, and deletion of customer lists.

API Principles

The Entities API follows RESTful principles, utilizing standard HTTP methods to interact with resources. All responses are formatted in JSON, ensuring easy integration into user interfaces.

Security and Compliance

All server-to-server calls must comply with the API security protocol and signing procedure and adhere to the defined API rate limits.