---
title: "Create a Loyalty Member API"
method: POST
path: "/members"
---

# Create a Loyalty Member API

`POST /members`

## Query parameters

- `language` string

## Request body

- CreateMemberRequestBody
  - `member_id` string, required — Unique Identifier (Member ID) for the member object in the client’s system. Examples include “Customer ID”, “GUID”, “Email Address”, “Phone Number”
  - `first_name` string — <p>First name of the loyalty member.</p> <p><strong>Please Note:</strong> The first name should be less than 100 characters.</p>
  - `last_name` string — <p>Last name of the loyalty member.</p> <p><strong>Please Note:</strong> The last name should be less than 100 characters.</p>
  - `email_address` string — <p>Email address of the loyalty member. You will not be able to use Zinrelo"s in-built email notifications if this field is not set.</p> <p><strong>Note:</strong> Optional, if this is not marked as a unique field.</p>
  - `phone_number` string — <p>Phone number of the loyalty member. Format : &lt;+COUNTRY CODE - PHONE NUMBER&gt; E.g : +1-7203332525 COUNTRY CODE defaults to +1</p> <p><strong>Note:</strong> Optional, if this is not marked as a unique field. REQUIRED if marked as unique.</p>
  - `birthdate` string — <p>Birthdate of the loyalty member. Format : &lt;MM/DD/YYYY&gt;</p> <p><strong>Note:</strong> Our API records all date and time fields in UTC time.</p>
  - `anniversary_date` string — <p>Wedding anniversary date of the loyalty member. Format : &lt;MM/DD/YYYY&gt;</p> <p><strong>Note:</strong> Our API records all date and time fields in UTC time.</p>
  - `twitter_handle` string — Twitter username of the loyalty member.
  - `preferred_language` string — Enter your preferred language.
  - `instagram_handle` string — Instagram username of the loyalty member.
  - `address` CreateMemberAddressObject
    - `city` string — Member's city.
    - `country` string — Member's country.
    - `line2` string — The member address.
    - `line1` string — The member address.
    - `state` string — Member's state.
    - `postal_code` string — Member's postal code.
  - `referrer_code` string — If a member has used a referral code shared by a friend, which you may have captured in the user registration form, you may pass it in referrer_code to let Zinrelo identify the friend who referred this member.
  - `member_tags` string[] — <p>List of tags that you"d want to tag this member with.</p> <p><strong>IMPORTANT:</strong> Updating the member tags will wipe out the existing tags and add the new array of tags. If you wish to append the new tag to an existing list, please make sure you retrieve the existing tags first , add the new tag to this list of existing tags and then make the update API call.</p>
  - `email_subscription_status` string — Values can be ‘subscribed’ or ‘unsubscribed’. If ‘unsubscribed’, this member will not receive any email notifications triggered by Zinrelo. Default value is ‘subscribed’.
  - `member_status` string — <p>Accepted values in the request are <strong>"active" , "blocked", "opted_out".</strong> Default is "active". <strong>"active"</strong> member is the one accumulating loyalty points and has access to rewards and earning opportunities. <strong>"blocked"</strong> member is prohibited from participating in the program.<strong> "opted_out"</strong> member is the one who has chosen to opt out of the loyalty program. </p>
  - `current_tier_id` string — The ID of the tier the member should be assigned.
  - `custom_attributes` string, json — <p>Apart from the above parameters, you can also pass in custom attributes that you want Zinrelo to associate with this member. You will first need to define the custom member attributes and then use the internal IDs in the API to pass the data. All the custom attributes will have to be passed in a dictionary called "custom_attributes" . "For e . g - Let"s assume you define a new group called - Demographics Info and education, nationality, religion as the custom attributes in that group, the new dictionary that you can pass in the API is as follows: <br />&ldquo;custom_attributes&rdquo;: {"wishlist" : ["shirt", "t-shirt"], "preferred stores" : ["USA", "France"] }</p>

## Response `200`

200

- CreateMemberDataObject
  - `schema` CreateMemberResponseObject
    - `deprecated_fields` DeprecatedMemberFieldsObject — These are the deprecated fields in Zinrelo.
      - `user_id` string — This field is going to be deprecated soon. We highly recommend not to use this field.
    - `lifetime_points_earned` integer — The total points earned in a member's account since he joined the program.
    - `twitter_handle` string — The twitter handle of the member.
    - `revenue` integer — The total revenue earned by the member.
    - `lifetime_points_expired` integer — The total points expired from a member's account since he joined the program.
    - `last_modified_date` string — The most recent date on which a member's profile was updated.
    - `available_points` integer — The avaliable points of the member.
    - `pending_points` integer — The pending points of the member.
    - `last_name` string — The last name of the member.
    - `referral_URL` string — The unique referral url of the member.
    - `member_status` string — The current status of the member- ‘active’ , ‘blocked’, ‘opted_out’. ‘active’ member is the one accumulating loyalty points and has access to rewards and earning opportunities. ‘blocked’ member is prohibited from participating in the program. ‘opted_out’ member is the one who has chosen to opt out of the loyalty program.
    - `referral_code` string — The unique referral code of the member.
    - `email_address` string — The email address of the member.
    - `id` string — The internal ID generated by Zinrelo.
    - `first_name` string — The first name of the member.
    - `number_of_activities` string — Number of activities performed by a member.
    - `member_tags` string[] — The tags assocaited with a member.
    - `referrer_code` string — The coupon code assigned to the referee for referring the friend.
    - `tier_info` CreateMemberTierObject
      - `current_period_start` string — The start date of the current tier cycle.
      - `tier_qualification_units` string — The total amount or points of qualifying activities performed.
      - `loyalty_tier_name` string — The name of the current tier.
      - `loyalty_tier_id` string — The unique tier ID stored in Zinrelo.
      - `current_period_end` string — The end date of current tier cycle.
      - `qualified_points` integer — The qualified points for tier calculation.
    - `custom_attributes` unknown
    - `referrer_ID` string — The unique transaction ID associated with the referee.
    - `first_purchase_date` string — The first purchase date of the member.
    - `lifetime_points_deducted` integer — The total points deducted from a member's account since he joined the program.
    - `phone_number` string — The phone number of the member.
    - `points_expiration_schedule` CreateMemberPointExpirationObject[]
      - `expiration_date` string — The expiration date of the available points.
      - `points` integer — The total number of points that will expire.
    - `instagram_handle` string — The instagram handle of the member.
    - `referrer_name` string — The name of the person who referred.
    - `aov` integer — The Average Order Value (AOV) is a metric used in business to determine the average total amount spent by customers in a single transaction or purchase. It's calculated by dividing the total revenue generated from sales by the total number of purchases made during a specific period.
    - `address` CreateMemberAddressObject
      - `city` string — Member's city.
      - `country` string — Member's country.
      - `line2` string — The member address.
      - `line1` string — The member address.
      - `state` string — Member's state.
      - `postal_code` string — Member's postal code.
    - `deleted_date` string — The date on which a member is deleted. In this case, the value will be null because it is a member creation API.
    - `last_purchase_date` string — The last purchase date of the member.
    - `lifetime_points_redeemed` integer — The total points redeemed from a member's account since he joined the program.
    - `preferred_language` string — The preferred language of the member.
    - `number_of_purchases` integer — The number of purchases made by a member.
    - `gender` string — The gender of the member.
    - `number_of_redemptions` integer — The number of redemptions made by a member.
    - `birthdate` string — Birthdate of the loyalty member. Expected date format: MM/DD/YYYY or MM/DD Irrespective of the year passed, 1904 will be set as a default value.
    - `anniversary_date` string — The anniversary date of the member. Expected date format: MM/DD/YYYY or MM/DD In case, where a year has not been passed the default year will be set as 1904.
    - `enrollment_date` string — The date on which the member joined the loyalty program.
    - `member_id` string — The unique identifier of the member defined by an Admin.
    - `email_subscription_status` string — The subscription status of the email. If ‘unsubscribed’, the member will not receive any email notifications triggered by Zinrelo. Default value is ‘subscribed’.
  - `success` boolean

## Other responses

- `400` — 400

---

[API](https://skmtc.net/trueloyal/apis/admin-apis.md) · [All operations](https://skmtc.net/trueloyal/apis/admin-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trueloyal/admin-apis/versions/c12d3d379897/schema)