Merge pull request #5327 from colemanw/totten-master-headerlist

[civicrm-core.git] / api / v3 / Premium.php

diff --git a/api/v3/Premium.php b/api/v3/Premium.php
index 52827ccc1e38c555119cbbcc482c7ab3e9a505f1..2ae0961de388bd54a48861d80b6a52d33229e271 100644 (file)
--- a/api/v3/Premium.php
+++ b/api/v3/Premium.php
@@ -26,7 +26,11 @@
  */
 
 /**
- * This api exposes CiviCRM premium.
+ * This api exposes CiviCRM premiums.
+ *
+ * Premiums are used as incentive gifts on contribution pages.
+ * Premiums contain "Products" which has a separate api.
+ * Use chaining to create a premium and related products in one api call.
  *
  * @package CiviCRM_APIv3
  */
@@ -38,7 +42,6 @@
  *
  * @throws API_Exception
  * @return array
- *   Array of newly created premium property values.
  */
 function civicrm_api3_premium_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);