LogoLogo
HomepageCase studiesBook a demo
Technical Guide
Technical Guide
  • Introduction
  • Getting Started Guide
    • Authentication
    • Member Registration Configuration
    • Add Webhook
    • Add Member
    • Create Campaign
    • Add Transaction
    • Add Custom Event Schema
    • Create Achievement
    • Add Custom Event
  • Terms Reference
  • Backward Compatibility Policy
  • API Reference
  • Postman Collection
  • User Guide
  • Integration
    • Introduction
    • Overview of Integration Methods
    • Tools and Technologies
    • Integration Examples
      • Lambda
      • Zapier
      • AWS EventBridge
      • Kafka
  • API Fundamentals
    • Overview
    • Environments Capabilities
    • How to Query
    • Limits
    • Best Practices
  • Authentication
    • Admin Token
    • Access Token (API Key)
    • Enabling SSO Login
      • Okta
      • Microsoft Entra ID
  • Webhooks
    • Overview
    • Best Practices
  • S3 Bucket Data exports
    • Overview
    • Set Up S3 Bucket Integration
    • Data Structure and Types
      • Achievements
      • Achievement Usage
      • Campaigns
      • Campaign Calculated Effect Result
      • Campaign Execution
      • Custom Events
      • Members
      • Rewards
      • Rewards Redemption
      • Tiers
      • Transactions
      • Tenants
      • Unit Transfers
Powered by GitBook
  1. Getting Started Guide

Add Member

See the sample example how a member can be added. Links to more detailed instructions can be found at the end of the article.

Last updated 7 months ago

Was this helpful?

How this example works

In this example, you can register a new member profile using the previously specified registration method.

The endpoint used in this example is the recommended one, and it requires an admin token to be used.


Try yourself

  • Input the previous saved and in the request header

  • Add a member Endpoint: POST /api/{storeCode}/member

    {
       "customer": {
            "email": "john.smith@example.com",
            "firstName": "John",
            "lastName": "Smith",
            "gender": "male"
        }
    }
  • This action should trigger CustomerRegistered


Endpoints used


More resources

For a detailed overview and description of the members, please refer to these series of articles:

token
storeCode
webhook

Method allows registering new member.

post

This method allows registering a new Member as an Admin.

Authorizations
Path parameters
storeCodestringRequired

Store code

Body
customerall ofOptional
and
Responses
200
Return registered member id and email.
application/json
400
Bad request.
application/json
401
Unauthorized.
application/json
403
Forbidden.
application/json
404
Not found.
application/json
post
POST /api/{storeCode}/member HTTP/1.1
Host: openloyalty.localhost
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 526

{
  "customer": {
    "referrerToken": "text",
    "firstName": "text",
    "lastName": "text",
    "gender": "male",
    "email": "text",
    "phone": "text",
    "loyaltyCardNumber": "text",
    "birthDate": "2025-05-16",
    "registeredAt": "2025-05-16T07:16:44.224Z",
    "address": {
      "street": "text",
      "address1": "text",
      "address2": "text",
      "postal": "text",
      "city": "text",
      "province": "text",
      "country": "text"
    },
    "company": {
      "name": "text",
      "nip": "text"
    },
    "labels": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "agreement1": true,
    "agreement2": true,
    "agreement3": true,
    "levelId": "123e4567-e89b-12d3-a456-426614174000"
  }
}
{
  "customerId": "00000000-0000-0000-0000-000000000000",
  "email": "text"
}
MembersIn this section, we will cover everything related to Loyalty Program Members. We will show you all the operations you can do on each Member and what you can achieve with them.