+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
*/
/**
- * This api exposes CiviCRM campaign.
+ * This api exposes CiviCRM Campaign records.
+ *
+ * @note Campaign component must be enabled.
*
* @package CiviCRM_APIv3
- * @subpackage API_Campaign
*/
/**
- * Create/update campaign.
+ * Create/update Campaign.
*
* This API is used to create new campaign or update any of the existing
* In case of updating existing campaign, id of that particular campaign must
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_campaign_create_spec(&$params) {
$params['title']['api.required'] = 1;
}
/**
- * Returns array of campaigns matching a set of one or more group properties.
+ * Returns array of campaigns matching a set of one or more properties.
*
* @param array $params
* Array per getfields
/**
* Delete an existing campaign.
*
- * This method is used to delete any existing campaign. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing campaign.
+ * Id of the campaign to be deleted is required field in $params array
*
* @param array $params
* array containing id of the group to be deleted