Program memberships

Creates a new membership with a given wallet_address, external_user_id, or both.

post

Invoke this endpoint to add a new membership to your loyalty program.

Authorizations

Body

family_member_birthdays[status]stringrequired

family member's membership status

family_member_birthdays[first_name]stringrequired

the first name of the family member

family_member_birthdays[birthday]stringrequired

the birthday of the family member

external_user_idstringoptional

the user's external_user_id (must be provided if wallet_address is blank)

wallet_addressstringoptional

the user's wallet_address (must be provided if external_user_id is blank)

emailstringoptional

the user's email address

phonestringoptional

the user's phone

birthdaystringoptional

The user's birthday

first_namestringoptional

The user's first name

last_namestringoptional

The user's last name

include_magic_linkbooleanoptional

Whether to return a magic link URL. Defaults to false.

family_member_birthdays[last_name]stringoptional

the last name of the family member

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/program-memberships' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'family_member_birthdays[status]=text&family_member_birthdays[first_name]=text&family_member_birthdays[birthday]=text&external_user_id=text&wallet_address=text&email=text&phone=text&birthday=text&first_name=text&last_name=text&include_magic_link=true&family_member_birthdays[last_name]=text'

200

400

200

{
  "membership": {
    "id": "text",
    "external_user_id": "text",
    "wallet_address": "text",
    "profile_image": "text",
    "on_chain_token_id": "text",
    "created_at": 1,
    "social_media_credentials": {
      "twitter_username": "text",
      "instagram_username": "text",
      "tiktok_username": "text"
    },
    "family_member_birthdays": [
      "text"
    ]
  }
}

Membership was created successfully, or an existing membership was found

Endpoint to update a program membership with a wallet_address, on_chain_token_id, and/or external_user_id

patch

Sets a wallet_address, on_chain_token_id, and/or external_user_id on the specified program_membership.

Authorizations

Path parameters

program_membership_idanyrequired

Body

family_member_birthdays[status]stringrequired

family member's membership status

family_member_birthdays[first_name]stringrequired

the first name of the family member

family_member_birthdays[birthday]stringrequired

the birthday of the family member

wallet_addressstringoptional

the wallet address to update the program membership with

on_chain_token_idstringoptional

the on chain token id to update the program membership with

external_user_idstringoptional

the external user id to update the program membership with

birthdaystringoptional

The user's birthday

first_namestringoptional

The user's first name

last_namestringoptional

The user's last name

emailstringoptional

the user's email address

phonestringoptional

the user's phone number

family_member_birthdays[last_name]stringoptional

the last name of the family member

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/v2/program-memberships/{program_membership_id}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'family_member_birthdays[status]=text&family_member_birthdays[first_name]=text&family_member_birthdays[birthday]=text&wallet_address=text&on_chain_token_id=text&external_user_id=text&birthday=text&first_name=text&last_name=text&email=text&phone=text&family_member_birthdays[last_name]=text'

200

200

{
  "membership": {
    "id": "text",
    "external_user_id": "text",
    "wallet_address": "text",
    "profile_image": "text",
    "on_chain_token_id": "text",
    "created_at": 1,
    "social_media_credentials": {
      "twitter_username": "text",
      "instagram_username": "text",
      "tiktok_username": "text"
    },
    "family_member_birthdays": [
      "text"
    ]
  }
}

Membership was updated with provided wallet_address, on_chain_token_id, and/or external_user_id