Membership Programs - Create New

Create a new Membership Program for a business (client account). After creating a membership program you can proceed to create multiple membership levels (e.g. Basic, Silver, Gold) for that program.

Membership Programs - Update

Allows you to update the configuration of an existing Membership Program.

Membership Programs - Retrieve Information

Retrieves the the configuration details of an existing Membership Program.

Membership Programs - List

Retrieves the list of existing Membership Programs for a given account.

Membership Programs - Delete

Deletes a Membership Program and its Membership Levels permanently.

Membership Levels - Create New

Create a new Membership Level for a given Membership Program. The Membership Level configuration contains the conditions that customers have to meet in order to belong to that Membership Level. Example: Customers need to earn at least 25000 points in the last 12 months in order to belong to the Gold Membership Level.

Membership Levels - Update

Update an existing Membership Level configuration for a given Membership Program.

Membership Levels - Retrive Information

Retrives information about an existing Membership Level.

Membership Levels - List

Retrives the list of existing Membership Levels in a given Membership Program.

Membership Levels - Delete

Removes a Membership Level permanently.

`Membership Programs - Create New`

The data to be submitted to the API is composed of the following fields:

field	Example	Note
API	1.5	Required
user_id	john1970	Required
user_api_key	1959caadac9b13dcb3	Required
type	manage_memberships	Required
action	new	Required
account_id	greatwidgets	Required
membership_program_name	Amazing Rewards	Required
membership_type	A, or B	Required See notes
membership_time_range	6	Required
membership_time_unit	M	Required D=Days M=Months Y=Years
membership_custom_qualifier_name	Nights	Required only for membership type B
membership_campaigns_included	all, or campaign ID	Required
Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Notes:

Membership types available: A = Based on Points Accrued (amount of points earned by the customer over a period of time). B = Based on Custom Qualifier (allows you to define a particular activity that is being tracked, example: number of nights that a customer is staying at a hotel).
Membership customer qualifier name: The membership custom qualifier name is only requierd for membership type "B". Example: membership_custom_qualifier_name= Nights (if you are tracking how many nights a customer needs to stay at a hotel in order to qualify for a higher membership level.)
Time range: number of days (D), months (M), or years (Y) that you want to include in order to define which customers qualify for each membership level.
Time unit: D for days, M for months, and Y for years.

Example PHP Request:

If you are using PHP, the $data array would look like this:


                $data['API'] = '1.5';
                $data['user_id'] = 'john1970';
                $data['user_api_key'] = '1959caadac9b13dcb3'; 
                $data['account_id'] = 'greatwidgets';
                $data['type'] = 'manage_memberships';
                $data['action'] = 'new';
                $data['membership_program_name'] = 'Amazing Rewards'
                $data['membership_style'] = 'A';
                $data['membership_time_range'] = '6';
                $data['membership_time_unit'] = 'M';
                $data['membership_campaigns_included'] = 'all';

Success XML Response:


                <response status="success">
                    <membership_program_id>
                        <id>5208143496464281</id>
                    </membership_program_id>
                </response>

Error XML Response:


                <response status="error">
                    <error>Error message</error>
                </response>

`Membership Programs - Update`

The data to be submitted to the API is composed of the following fields:

field	Example	Note
API	1.5	Required
user_id	john1970	Required
user_api_key	1959caadac9b13dcb3	Required
type	manage_memberships	Required
action	update	Required
account_id	greatwidgets	Required
membership_program_name	Amazing Rewards Club	Required
membership_type	A, or B	Required See notes
membership_program_id	5208143496464281	Required
membership_time_range	12	Required
membership_time_unit	M	Required D=Days M=Months Y=Years
membership_custom_qualifier_name	Nights	Required only for membership type B
membership_campaigns_included	all, or campaign ID	Required
Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Notes:

Membership types available: A = Based on Points Accrued (amount of points earned by the customer over a period of time). B = Based on Custom Qualifier (allows you to define a particular activity that is being tracked, example: number of nights that a customer is staying at a hotel).
Membership customer qualifier name: The membership custom qualifier name is only requierd for membership type "B". Example: membership_custom_qualifier_name= Nights (if you are tracking how many nights a customer needs to stay at a hotel in order to qualify for a higher membership level.)
Time range: number of days (D), months (M), or years (Y) that you want to include in order to define which customers qualify for each membership level.
Time unit: D for days, M for months, and Y for years.

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['API'] = '1.5';
              $data['user_id'] = 'john1970';
              $data['user_api_key'] = '1959caadac9b13dcb3'; 
              $data['account_id'] = 'greatwidgets';
              $data['type'] = 'manage_memberships';
              $data['action'] = 'update';
              $data['membership_program_id'] = '5208143496464281';
              $data['membership_program_name'] = 'Amazing Rewards Club'
              $data['membership_style'] = 'A';
              $data['membership_time_range'] = '12';
              $data['membership_time_unit'] = 'M';
              $data['membership_campaigns_included'] = 'all';

Success XML Response:


              <response status="success">
                  <membership_program_id>
                    <id>5208143496464281</id>
                  </membership_program_id>
              </response>

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>

`Membership Programs - Retrieve Information`

The data to be submitted to the API is composed of the following fields:

field	Example	Note
API	1.5	Required
user_id	john1970	Required
user_api_key	1959ca5645adac9b13dcb3	Required
account_id	greatwidgets	Required
type	manage_memberships	Required
action	info	Required
membership_program_id	5208143496464281	Required
include_levels	Y	Optional
Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['API'] = '1.5';
              $data['user_id'] = 'john1970';
              $data['user_api_key'] 	= '1959caadac9b13dcb3';	
              $data['type'] = 'manage_memberships';
              $data['action'] = 'info';
              $data['account_id'] = 'greatwidgets';
              $data['membership_program_id'] = '5208143496464281';
              $data['include_membership_levels'] = 'Y';

Success XML Response


              <response status="success">
              <membership>
                  <membership_program_id>5208143496464281</membership_program_id>
                  <membership_program_name>Amazing Rewards Club</membership_program_name>
                  <membership_custom_qualifier_name></membership_custom_qualifier_name>
                  <membership_style>A</membership_style>
                  <membership_time_range>12</membership_time_range>
                  <membership_time_unit>M</membership_time_unit>
                  <membership_campaigns_included>all</membership_campaigns_included>
                  <membership_levels>
                      <membership_level_id_id>43</membership_level_id>
                      <membership_program_id>2303626404596905</membership_program_id>
                      <membership_level_qualifier>0</membership_level_qualifier>
                      <membership_level_multiplier>1</membership_level_multiplier>
                      <membership_level_description>Basic</membership_level_description>
                  </membership_levels>
                  <membership_levels>
                      <membership_level_id_id>44</membership_level_id>
                      <membership_program_id>2303626404596905</membership_program_id>
                      <membership_level_qualifier>2500</membership_level_qualifier>
                      <membership_level_multiplier>1.20</membership_level_multiplier>
                      <membership_level_description>Bronze</membership_level_description>
                  </membership_levels>
                  <membership_levels>
                      <membership_level_id_id>45</membership_level_id>
                      <membership_program_id>2303626404596905</membership_program_id>
                      <membership_level_qualifier>5000</membership_level_qualifier>
                      <membership_level_multiplier>1.30</membership_level_multiplier>
                      <membership_level_description>Silver</membership_level_description>
                  </membership_levels>
                  <membership_levels>
                      <membership_level_id_id>46</membership_level_id>
                      <membership_program_id>2303626404596905</membership_program_id>
                      <membership_level_qualifier>10000</membership_level_qualifier>
                      <membership_level_multiplier>1.50</membership_level_multiplier>
                      <membership_level_description>Gold</membership_level_description>
                  </membership_levels>
              </membership>
              </response>

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>

`Membership Programs - List`

The data to be submitted to the API is composed of the following fields:

field	Example	Note
API	1.5	Required
user_id	john1970	Required
user_api_key	1959ca5645adac9b13dcb3	Required
account_id	greatwidgets	Required
type	manage_memberships	Required
action	list	Required
include_membership_levels	Y	Optional
Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['API'] = '1.5';
              $data['user_id'] = 'john1970';
              $data['user_api_key'] 	= '1959caadac9b13dcb3';	
              $data['type'] = 'manage_memberships';
              $data['action'] = 'list';
              $data['account_id'] = 'greatwidgets';
              $data['include_membership_levels'] = 'Y';

Success XML Response


              <response status="success">
                  <membership>
                      <membership_program_id>5208143496464281</membership_program_id>
                      <membership_program_name>Amazing Rewards Club</membership_program_name>
                      <membership_custom_qualifier_name></membership_custom_qualifier_name>
                      <membership_style>A</membership_style>
                      <membership_time_range>12</membership_time_range>
                      <membership_time_unit>M</membership_time_unit>
                      <membership_campaigns_included>all</membership_campaigns_included>
                      <membership_levels>
                          <membership_level_id_id>43</membership_level_id>
                          <membership_program_id>2303626404596905</membership_program_id>
                          <membership_level_qualifier>0</membership_level_qualifier>
                          <membership_level_multiplier>1</membership_level_multiplier>
                          <membership_level_description>Basic</membership_level_description>
                      </membership_levels>
                      <membership_levels>
                          <membership_level_id_id>44</membership_level_id>
                          <membership_program_id>2303626404596905</membership_program_id>
                          <membership_level_qualifier>2500</membership_level_qualifier>
                          <membership_level_multiplier>1.20</membership_level_multiplier>
                        <membership_level_description>Bronze</membership_level_description>
                      </membership_levels>
                      <membership_levels>
                          <membership_level_id_id>45</membership_level_id>
                          <membership_program_id>2303626404596905</membership_program_id>
                          <membership_level_qualifier>5000</membership_level_qualifier>
                          <membership_level_multiplier>1.30</membership_level_multiplier>
                          <membership_level_description>Silver</membership_level_description>
                      </membership_levels>
                      <membership_levels>
                          <membership_level_id_id>46</membership_level_id>
                          <membership_program_id>2303626404596905</membership_program_id>
                          <membership_level_qualifier>10000</membership_level_qualifier>
                          <membership_level_multiplier>1.50</membership_level_multiplier>
                          <membership_level_description>Gold</membership_level_description>
                      </membership_levels>
                  </membership>
              </response>

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>

`Membership Programs - Delete`

The data to be submitted to the API is composed of the following fields:

field	Example	Note
API	1.5	Required
user_id	john1970	Required
user_api_key	1959ca5645adac9b13dcb3	Required
account_id	greatwidgets	Required
type	manage_memberships	Required
action	delete	Required
membership_program_id	5208143496464281	Required
Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['API'] = '1.5';
              $data['user_id'] = 'john1970';
              $data['uuser_api_key'] 	= '1959caadac9b13dcb3';	
              $data['type'] = 'manage_memberships';
              $data['action'] = 'delete';
              $data['membership_program_id'] = '5208143496464281';

Success XML Response


              <response status="success">
              </response>

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>

`Membership Levels - Create New`

The data to be submitted to the API is composed of the following fields:

field	Example	Note
user_id	john1970	Required
API	1.5	Required
user_id	john1970	Required
user_api_key	1959caadac9b13dcb3	Required
type	manage_membership_levels	Required
action	new	Required
account_id	greatwidgets	Required
membership_program_id	1503061175851366	Required
membership_level_description	Gold	Required
membership_level_qualifier	500	Required
membership_level_multiplier	1.5	Required
Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Notes:

Membership level qualifier: Determines the minimum amount of points (or custom qualifier events) that customers need to meet in order to belong to a particular Membership Level.
Membership level multiplier: Determines the bonus/extra points that customers will earn when they belong to a particular Membership Level.
A base membership level is needed: All Membership Programs must have a base Membership Level. Example: 0 points needed to be in the Basic Level, membership_level_multiplier= 1 (no additional points earned) This will allow the system to label all participating customers as members of a basic/beginning level.

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['API'] = '1.5';
              $data['user_id'] = 'john1970';
              $data['user_api_key'] = '1959caadac9b13dcb3'; 
              $data['account_id'] = 'greatwidgets';
              $data['type'] = 'manage_membership_levels';
              $data['action'] = 'new';
              $data['membership_program_id'] = '5208143496464281'
              $data['membership_level_qualifier'] = '25000';
              $data['membership_level_multiplier'] = '2';
              $data['membership_level_description'] = 'Gold';

Success XML Response:


              <response status="success">
                <membership_level_id>55</membership_level_id>
              </response>

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>

`Membership Levels - Update`

The data to be submitted to the API is composed of the following fields:

field	Example	Note
API	1.5	Required
user_id	john1970	Required
user_api_key	1959caadac9b13dcb3	Required
type	manage_membership_levels	Required
action	update	Required
account_id	greatwidgets	Required
membership_level_id	30	Required
membership_level_description	Gold	Required
membership_level_qualifier	50000	Required
membership_level_multiplier	2	Required
Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Notes:

Membership level qualifier: Determines the minimum amount of points (or custom qualifier events) that customers need to meet in order to belong to a particular Membership Level.
Membership level multiplier: Determines the bonus/extra points that customers will earn when they belong to a particular Membership Level.
A base membership level is needed: All Membership Programs must have a base Membership Level. Example: 0 points needed to be in the Basic Level, membership_level_multiplier= 1 (no additional points earned) This will allow the system to label all participating customers as members of a basic/beginning level.

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['API'] = '1.5';
              $data['user_id'] = 'john1970';
              $data['user_api_key'] = '1959caadac9b13dcb3'; 
              $data['account_id'] = 'greatwidgets';
              $data['type'] = 'manage_membership_levels';
              $data['action'] = 'update';
              $data['membership_level_id'] = '55'
              $data['membership_level_qualifier'] = '50000';
              $data['membership_level_multiplier'] = '2';
              $data['membership_level_description'] = 'Gold';

Success XML Response:


              <response status="success">
                <membership_level_id>55</membership_level_id>
              </response>

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>

`Membership Levels - Retrive Information`

The data to be submitted to the API is composed of the following fields:

field	Example	Note
API	1.5	Required
user_id	john1970	Required
user_api_key	1959ca5645adac9b13dcb3	Required
account_id	greatwidgets	Required
type	manage_membership_levels	Required
action	info	Required
membership_level_id	55	Required
Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Example PHP Request:

If you are using PHP, the $data array would look like this:


                $data['user_id'] = 'john1970';
                $data['user_api_key'] = '1959caadac9b13dcb3';	
                $data['type'] = 'manage_membership_levels';
                $data['action'] = 'info';
                $data['account_id'] = 'greatwidgets';
                $data['membership_level_id'] = '55';

Success XML Response


                <response status="success">
                    <membership_level>
                        <membership_level_id>55</membership_level_id>
                        <membership_program_id>8121227452706343</membership_program_id>
                        <membership_level_qualifier>50000</membership_level_qualifier>
                        <membership_level_multiplier>2.0</membership_level_multiplier>
                        <membership_level_description>Gold</membership_level_description>
                    </membership_level>
                </response>

Error XML Response:


                <response status="error">
                    <error>Error message</error>
                </response>

`Membership Levels - List`

The data to be submitted to the API is composed of the following fields:

field	Example	Note
API	1.5	Required
user_id	john1970	Required
user_api_key	1959ca5645adac9b13dcb3	Required
account_id	greatwidgets	Required
type	manage_membership_levels	Required
action	list	Required
membership_program_id	8121227452706343	Required
Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Example PHP Request:

If you are using PHP, the $data array would look like this:


                $data['API'] = '1.5';
                $data['user_id'] = 'john1970';
                $data['user_api_key'] 	= '1959caadac9b13dcb3';	
                $data['type'] = 'manage_membership_levels';
                $data['action'] = 'info';
                $data['account_id'] = 'greatwidgets';
                $data['membership_program_id'] = '8121227452706343';

Success XML Response


                <response status="success">
                    <membership_level>
                        <membership_level_id>53</membership_level_id>
                        <membership_program_id>8121227452706343</membership_program_id>
                        <membership_level_qualifier>0</membership_level_qualifier>
                        <membership_level_multiplier>1.0</membership_level_multiplier>
                        <membership_level_description>Basic</membership_level_description>
                    </membership_level>
                    <membership_level>
                        <membership_level_id>54</membership_level_id>
                        <membership_program_id>8121227452706343</membership_program_id>
                        <membership_level_qualifier>10000</membership_level_qualifier>
                        <membership_level_multiplier>1.5</membership_level_multiplier>
                        <membership_level_description>Silver</membership_level_description>
                    </membership_level>
                    <membership_level>
                        <membership_level_id>55</membership_level_id>
                        <membership_program_id>8121227452706343</membership_program_id>
                        <membership_level_qualifier>50000</membership_level_qualifier>
                        <membership_level_multiplier>2.0</membership_level_multiplier>
                        <membership_level_description>Gold</membership_level_description>
                    </membership_level>
                </response>

Error XML Response:


                <response status="error">
                    <error>Error message</error>
                </response>

`Membership Levels - Delete`

The data to be submitted to the API is composed of the following fields:

field	Example	Note
API	1.5	Required
user_id	john1970	Required
user_api_key	1959ca5645adac9b13dcb3	Required
account_id	greatwidgets	Required
type	manage_membership_levels	Required
action	delete	Required
membership_level_id	54	Required
Output Format:
output	JSON or XML	Optional. If not provided, defaults to XML
callback	someFunctionName	Optional: JSONP format
condensed	yes	Optional (No white space) Applies only to JSON(P) output

Example PHP Request:

If you are using PHP, the $data array would look like this:


              $data['API'] = '1.5';
              $data['user_id'] = 'john1970';
              $data['user_api_key'] = '1959caadac9b13dcb3';	
              $data['type'] = 'manage_membership_levels';
              $data['action'] = 'delete';
              $data['account_id'] = 'greatwidgets';
              $data['membership_level_id'] = '54';

Success XML Response


              <response status="success">
              </response>

Error XML Response:


              <response status="error">
                <error>Error message</error>
              </response>