Group.php
This api exposes CiviCRM Groups.
This api is for creating/deleting groups or fetching a list of existing groups. To add/remove contacts to a group, use the GroupContact api instead.
Table of Contents
Functions
- civicrm_api3_group_create() : array<string|int, mixed>
- Create/update group.
- _civicrm_api3_group_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_group_get() : array<string|int, mixed>
- Returns array of groups matching a set of one or more Group properties.
- civicrm_api3_group_delete() : array<string|int, mixed>
- Delete an existing Group.
Functions
civicrm_api3_group_create()
Create/update group.
civicrm_api3_group_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
name/value pairs to insert in new 'Group'
Return values
array<string|int, mixed> —API result array
_civicrm_api3_group_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_group_create_spec(array<string|int, mixed> &$params) : mixed
The metadata is used for setting defaults, documentation & validation.
Parameters
- $params : array<string|int, mixed>
-
Array of parameters determined by getfields.
civicrm_api3_group_get()
Returns array of groups matching a set of one or more Group properties.
civicrm_api3_group_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array of properties. If empty, all records will be returned.
Return values
array<string|int, mixed> —Array of matching groups
civicrm_api3_group_delete()
Delete an existing Group.
civicrm_api3_group_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
[id]
Tags
Return values
array<string|int, mixed> —API result array