Tag.php
This api exposes CiviCRM tags.
Tags are used to classify CRM entities (including Contacts, Groups and Actions).
Tags
Table of Contents
Functions
- civicrm_api3_tag_create() : array<string|int, mixed>
- Create or update a tag.
- _civicrm_api3_tag_create_spec() : mixed
- Specify Meta data for create.
- civicrm_api3_tag_delete() : array<string|int, mixed>
- Delete an existing Tag.
- civicrm_api3_tag_get() : array<string|int, mixed>
- Get a Tag.
Functions
civicrm_api3_tag_create()
Create or update a tag.
civicrm_api3_tag_create(array<string|int, mixed> $params) : array<string|int, mixed>
Tags are used to classify CRM entities (including Contacts, Groups and Actions).
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed> —API result array
_civicrm_api3_tag_create_spec()
Specify Meta data for create.
_civicrm_api3_tag_create_spec(array<string|int, mixed> &$params) : mixed
Note that this data is retrievable via the getfields function and is used for pre-filling defaults and ensuring mandatory requirements are met.
Parameters
- $params : array<string|int, mixed>
civicrm_api3_tag_delete()
Delete an existing Tag.
civicrm_api3_tag_delete(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —API result array
civicrm_api3_tag_get()
Get a Tag.
civicrm_api3_tag_get(array<string|int, mixed> $params) : array<string|int, mixed>
This api is used for finding an existing tag. Either id or name of tag are required parameters for this api.
Parameters
- $params : array<string|int, mixed>
-
Array per getfields metadata.
Return values
array<string|int, mixed> —API result array