Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zinrelo Members API

Enroll, retrieve, update, block, and manage loyalty program members.

Zinrelo Members API is one of 7 APIs that Zinrelo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Members. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 12 operations across 11 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.zinrelo.com.

12 operations 11 paths 9 schemas 8 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.zinrelo.com
Authentication
API Key, API Key
Contact
Resource Areas
1

Authentication & Security 2

Zinrelo Members API declares 2 security schemes for authenticating requests. An API key is passed in the header as partner-id (partnerId). An API key is passed in the header as api-key (apiKey). By default, every request must be authenticated.

  • partnerId — Your Zinrelo Partner ID, provisioned to your account.
  • apiKey — Your Zinrelo API key, provisioned to your account.

Paths & Operations 12

Across 11 paths, the API surfaces 12 operations — 8 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Members 12

Enroll, retrieve, update, block, and manage loyalty program members.

GET
/v1/loyalty/users
List members
listMembers 2 params → 200401
POST
/v1/loyalty/users
Create a member
createMember body → 200401
GET
/v1/loyalty/users/{user_email}
Get a member
getMember 1 param → 200401404
GET
/v1/loyalty/users/{user_email}/transactions
List a member's transactions
listMemberTransactions 1 param → 200401
GET
/v1/loyalty/users/{user_email}/eligible_activities
List a member's eligible activities
listMemberEligibleActivities 1 param → 200401
GET
/v1/loyalty/users/{user_email}/redemptions
List a member's redemptions
listMemberRedemptions 1 param → 200401
GET
/v1/loyalty/users/{user_email}/next_tier
Get a member's next tier
getMemberNextTier 1 param → 200401
PUT
/v1/loyalty/users/{user_email}/block
Block a member
blockMember 1 param → 200401
POST
/v1/loyalty/update_user_email
Update a member's email
updateMemberEmail body → 200401
POST
/v1/loyalty/unsubscribe_email
Unsubscribe a member
unsubscribeMember body → 200401
GET
/v1/loyalty/unsubscribed_users
List unsubscribed members
listUnsubscribedMembers → 200401
GET
/v2/loyalty-storefront/transactions
List member transactions (storefront)
listStorefrontTransactions 4 params → 200401

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Member (8 properties), Transaction (7 properties), Redemption (5 properties), MemberCreate (3 properties). Each schema is shown below with its type and property counts.

RedemptionList
object
2 properties
TransactionList
object
2 properties
Member
object
8 properties
Transaction
object
7 properties
Redemption
object
5 properties
Error
object
3 properties
MemberCreate
object
3 properties 1 required
StatusResponse
object
2 properties
MemberList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinrelo-members-api-openapi.yml Raw ↑

Other APIs Zinrelo publishes across the network.

Zinrelo Events API
Zinrelo Points API
Zinrelo Redemptions API
Zinrelo Rewards API
Zinrelo Tiers API
Zinrelo Transactions API