MenuClose

Member Group - API Reference

Select API:

Member Group

Group members/customers, each member can belong to unlimited groups. Groups can contain groups

End Point URL

https://api.cms-tool.net/webapps/api/membergroups

API Parameters and Filters

Name Description Example Optional Data type
data The JSON you would like to POST. This can be POST content also
data =
{
"note_subject" : "notes from api",
"note_body" : "This is a new note"
}


 Yes json object
id Search a group by it's id id=123 Yes int
group Search a group by it's name group="Devs" Yes string
userSelectable

Search a group by it's user selectable status

 userSelectable="t" Yes boolean
memberCount

Search a group by the number of member count in the group.
Use matchType parameter along for more control over the data.

memberCount=10
matchType=>

 Yes int

Data Dictionary

Key Definition Type Format
cid
Website ID
System ID of Website (readonly)
int
Max Len: 11
e.g. 123456
mbr_group_parent
Group parent ID, wh
ID of a parent group in a nested group heirachy
int
Max Len: 11
mbr_group
Group Name
The name of this member group
text
mbr_group_count_members
Member Count
Count of members in this group (readonly)
int
Max Len: 11
mbr_groupid
Group ID
System generated group ID (readonly, primary ID)
Integer (Unique ID)
Max Len: 11
e.g. 123456
mbr_group_user_selectable
User selectable
Can a user enroll to join this group when they register. If false, it is a secret group only manageable by website admins
bool
Max Len: 1
true/false

Usage Instructions and Examples

View your member groups

Use the member groups endpoint with GET method to get all the member groups.

{ 
   "id":123,

"cid": 111,

"mbr_group": "Special Members",

"mbr_group_count_members": "20",

"mbr_group_user_selectable": "t"

}
   ...

Create new member group

To create a new entry use POST method. Do not provide the id to create a new group.

Example:

{

"mbr_group": "New Special Members",

"mbr_group_count_members": "20",

"mbr_group_user_selectable": "t"

}

Update a member group

To update a group please provide the id of the group you wish to update. Rest of the information will be used to update the group. The member group count can not be updated without adding the members to the group first.

Example:

{

   "id": 1234,

   "mbr_group": "New Special Members",

   "mbr_group_user_selectable": "t"

}

Sample Object


{
"mbr_group_count_members":7,
"mbr_group":"Developers",
"mbr_group_user_selectable":"f",
"id":23958,
"cid":1234
}