canonical: https://jentic.com/apis/socialannex.net/socialannex # Socialannex Annex Cloud Loyalty API REST API for managing loyalty program users, orders, points, rewards, segments, and campaigns in Annex Cloud. The API exposes 14 endpoints secured with bearer authentication. ## For AI agents Programmatically create user and add to loyalty program, retrieve user profile information. Covers 14 operations with bearer authentication. ## Scope Does not handle payments, communications, or crm - use for marketing only. ## Capabilities - Create user and add to loyalty program - Retrieve user profile information - Modify user profile - Query and filter Annex Cloud Loyalty API records by parameters - Monitor Annex Cloud Loyalty API operational status and events ## Use cases ### Marketing Operations Use the Annex Cloud Loyalty API to perform marketing operations programmatically. The API provides 14 endpoints covering core functionality including create user and add to loyalty program, retrieve user profile information, modify user profile. Example prompt: Call POST /users to create user and add to loyalty program ### Automated Users Management Automate users operations by combining multiple Annex Cloud Loyalty API endpoints. Agents can retrieve user profile information and then modify user profile in a single workflow. Example prompt: Call GET `/users/{id}` to retrieve user profile information, then verify the result ### AI Agent Integration via Jentic AI agents discover and call Annex Cloud Loyalty API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually. Example prompt: Search Jentic for 'create user and add to loyalty program', load the operation schema, and execute with Jentic-managed credentials ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/users` | Create user and add to loyalty program | | GET | `/users/{id}` | Retrieve user profile information | | PATCH | `/users/{id}` | Modify user profile | | GET | `/users/{id}/activity` | Retrieve user action/event history with point transactions | | GET | `/users/{id}/usedreward` | Retrieve claimed/redeemed rewards history | | GET | `/users/{userId}/tiers` | Retrieve current and next tier status with requirements | | GET | `/users/{id}/reward` | Retrieve available rewards eligible for user | | POST | `/orders` | Create new order and trigger loyalty point calculations | ## Key resources - **Users** — User management and loyalty profiles - **Orders** — Order management and point calculations - **Points** — Point balance and transactions - **Rewards** — Reward eligibility and redemption - **Segments** — User segmentation ## Why Jentic - **Setup:** Wiring the Annex Cloud Loyalty API by hand means sending your bearer token on every request, choosing between the production and stage socialannex.net hosts, and threading the loyalty user id through each call yourself. Through Jentic you install once, import the Annex Cloud Loyalty API from the API Directory, store the token once, and your agent calls it. - **Permission scoping:** The Annex Cloud Loyalty API puts the user id in the URL path (`/users/{id}/...`), so a rule can pin your agent to one loyalty member: it can read that member's activity, rewards, and tiers and nothing else. You choose the operations it may call, so writes like updating a member are only included if you add them. - **Credential handling:** Your Annex Cloud Loyalty API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'get a member's reward activity' or 'check a member's loyalty tier', and Jentic returns the matching Annex Cloud Loyalty API operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Mailchimp** — Alternative marketing API - **Hubspot** — Alternative marketing API ## FAQ ### What authentication does the Annex Cloud Loyalty API use? The Annex Cloud Loyalty API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context. ### Can I create user and add to loyalty program with the Annex Cloud Loyalty API? Yes. Use the POST /users endpoint. The API returns structured JSON responses that agents can parse and act on directly. ### What are the rate limits for the Annex Cloud Loyalty API? Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer. ### How do I create user and add to loyalty program through Jentic? Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create user and add to loyalty program'. Jentic returns the matching Annex Cloud Loyalty API operation with its input schema. Load the schema and execute the call - credentials are injected automatically. ### How many endpoints does the Annex Cloud Loyalty API have? The Annex Cloud Loyalty API exposes 14 endpoints covering users, orders, points operations. ### Can I limit what my agent is allowed to do with the Annex Cloud Loyalty API? Yes. Because you run Jentic One yourself, your own rules decide which Annex Cloud Loyalty API operations and credentials the agent may use. Since the API puts the loyalty member id in the URL path (`/users/{id}/...`), a rule can pin the agent to a single member so it reads only that member's activity, rewards, and tier status and nothing else. You also choose the exact operations it can call, so write actions like creating an order or modifying a member profile are available only if you include them.