v1

latestOpenAPI 3.0.02026-07-26868170.3 KB

Members

Create a member

Add a new member to a loyalty program.

post/loyalty/members

Request body

program_idinteger required

contact_idstring

The unique_key of your universe: email, cellphone or custom.

card_codestring

card_expire_atstring

The expiration date of subscription.

birthdaystring date

the birthday date for card code.

program_joined_atstring

the subscription external date.

forced_tier_namestring

force the setting of member tier from given tier name (you can also use vip tier name)

Example request

{
  "program_id": 1,
  "contact_id": "jdoe@yopmail.com",
  "card_code": "my_card_1234",
  "card_expire_at": "2018-01-12 15:00:00",
  "birthday": "2018-01-12",
  "program_joined_at": "2018-01-12 15:00:00",
  "forced_tier_name": "Tier #1"
}

Response

Loyalty subscription creation is successful.