Members / Customers - API Reference

Add a new member

To add a new member do not provide the member id. The rest of the information will be used to create a new member. It is a good idea to atleast provide the member email, name, phone and address while creating a new member. Member level should not be more than 500. To get a breakdown of member levels refer to Referene Endpoint /reference/memberlevel. You can create a Member to be Opt In member by providing OptIn name with value "yes". Email address is treated as a unique key, to ensure unique email accounts, with an optional override ?AllowDuplicateEmailAccounts=1

Example:

{

  "mbr_name": "name",

  "mbr_email": "abc@xyz.com",

  "optIn": true

}

Update an existing member

To update an existing member please provide either an existing member id, or reference, or email address. 

Reference or Email address are assumed to be an alternative unique key when no ID is provided. It remains possible that duplicates may already exist, so our system will only select the first record it finds during a POST update. If reference is provided, then the email lookup is ignored.  

If you provide the form post parameter ?AllowDuplicateEmailAccounts=1  then the email lookup step is ignored, and typically the record will then be inserted. 

Rest of the JSON data will be used to update the member. You can update a Member to be Opt In member by providing OptIn name with value "yes". 

Example:

{

  "id": 1234

  "mbr_name": "name",

  "mbr_email": "abc@xyz.com",

  "optIn": "yes"...

}

Manage Member Group Associations

Members can belong to different groups which can be used for different purposes. To link a member to a group include memberGroups array in your body. You must include a group name or id. If group does not exist we will create a new group.
The below example will create a new member and link it to the Member Groups.

Example using group names:

{

  "mbr_name": "name",

  "mbr_email": "abc@xyz.com",

  "memberGroups": [

         "Auckland",

          "Team 1"

    ]

}

{

  "mbr_name": "name",

  "mbr_email": "abc@xyz.com",

  "memberGroups": [

     {

        "name": "group 2"

     }, 

     {

        "id": 1234

      }

   ]

}

Delete Member Groups

Our API has been designed to make it easy to send minimal data to add a member to a group.  So if you simply exclude a group, this does not remove the member from the group. If you provide a group(s), the member is added to the group. 

If you want to delete group associations, then you will need to supply a complete array of member groups and add a request parameter, or a json data parameter (in top level) called "DeleteMissingArrayElements" and we will delete any items that are not in your array.  If you use this feature, it could affect any use of arrays within the member object, not just the groups.