groups_create_group
This endpoint is used to create a BuddyPress group.
Resource URL
https://www.domain.com/api/userplus/groups_create_group/
Method
POST
Required Parameters
- 'cookie' The user cookie that creates the group.
- key – get API key from Settings > User Plus
Optional Parameters
- 'name'
(string) The group name. - 'description'
(string) Optional. The group's description. - 'slug'
(string) The group slug. - 'status'
(string) The group's status. Accepts 'public', 'private' or 'hidden'. Defaults to 'public'. - 'parent_id'
(int) The ID of the parent group. Default: 0. - 'enable_forum'
(int) Optional. Whether the group has a forum enabled. If a bbPress forum is enabled for the group, set this to 1. Default: 0. - 'date_created'
(string) The GMT time, in Y-m-d h:i:s format, when the group was created. Defaults to the current time.
Endpoint Returns
The ID of the group on success. False on error.
Sample Response
{
"status": "ok",
"group_id": 5
}
Related Endpoints
- groups
- groups_delete_group
- groups_delete_groupmeta
- groups_edit_group_settings
- groups_get_avatar
- groups_get_cover
- groups_get_group
- groups_get_groupmeta
- groups_invite_user
- groups_invite_users_admin
- groups_is_user_admin
- groups_is_user_member
- groups_is_user_mod
- groups_join_group
- groups_join_group_admin
- groups_leave_group
- groups_members
- groups_post_update
- groups_send_membership_request
- groups_update_group
- groups_update_groupmeta