|
Membership Levels - Update
Update an existing Membership Level configuration for a given Membership Program.
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>
|
|