The Create Group API is a great way to create either single or multiple groups based on your community’s needs.
Supported Body Params:
Create Group
REQUEST
curl 'https://api.mobilize.io/v1/groups'
-X POST
-u [API Key]:[API Secret]
-H 'Content-Type: application/json'
-H 'Accept: application/json'
-d '{
"name": "9",
"parent_group_id": "1",
"privacy": "5",
"invite_members_enabled": "false",
"hidden_emails": "",
"alias_name": "group_name_9",
"default_emails_frequency": "0",
"manager_email_address": "sam_cooper@domain.com"
}'
Update Group
REQUEST
curl 'https://api.mobilize.io/v1/groups/1234'
-X POST
-u [API Key]:[API Secret]
-H 'Content-Type: application/json'
-H 'Accept: application/json'
-d '{
"name": "new_group_name",
"privacy": 5,
"invite_members_enabled": true,
"members_visible": false,
"requires_approval": true,
"hidden_emails": false,
"alias_name": "new_alias_name",
"default_emails_frequency": 1
}'
If the user id is not supplied, the user will be created automatically for convenience reasons. Make sure you include the email in the fields hash. If the users already exist it will overwrite the data with the data provided in the API body.
For adding an existing user to a group, add user_id param to the root of your JSON request.
The limit for each bulk is 1000 members, and you can only use one bulk API at a time.
For Bulk Group changes, please visit the Mobilize Readme for more information
Comments
0 comments
Please sign in to leave a comment.