GroupOrganization.php
This api exposes the relationships between organizations and CiviCRM groups.
Table of Contents
Functions
- civicrm_api3_group_organization_get() : array<string|int, mixed>
- Get group organization record/s.
- civicrm_api3_group_organization_create() : array<string|int, mixed>
- Create group organization record.
- _civicrm_api3_group_organization_create_spec() : mixed
- Adjust Metadata for Create action.
- civicrm_api3_group_organization_delete() : array<string|int, mixed>
- Deletes an existing Group Organization.
Functions
civicrm_api3_group_organization_get()
Get group organization record/s.
civicrm_api3_group_organization_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Name value pair of contact information.
Return values
array<string|int, mixed> —list of groups, given contact subscribed to
civicrm_api3_group_organization_create()
Create group organization record.
civicrm_api3_group_organization_create(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Array.
Return values
array<string|int, mixed>_civicrm_api3_group_organization_create_spec()
Adjust Metadata for Create action.
_civicrm_api3_group_organization_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_organization_delete()
Deletes an existing Group Organization.
civicrm_api3_group_organization_delete(array<string|int, mixed> $params) : array<string|int, mixed>
This API is used for deleting a Group Organization
Parameters
- $params : array<string|int, mixed>
-
With 'id' = ID of the Group Organization to be deleted.
Return values
array<string|int, mixed> —API Result