diff --git a/api/account-memberships/index.html b/api/account-memberships/index.html index 94894684d..8d25e284c 100644 --- a/api/account-memberships/index.html +++ b/api/account-memberships/index.html @@ -19,7 +19,7 @@
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs
Go to home page
Docs

Promotions

Promotions are a mechanism to reward accounts for completing certain actions.

+

Promotions

Promotions are a mechanism to reward accounts for completing certain actions.

Promotion Model

Attributes

Promotion Target Model

Attributes

  • type

    string

    Can be count or sum. count if the progress should be incremented by 1 each time. sum if the progress should be summed from the specified field property.

  • field

    string

    Only supplied if type is sum. This denotes which field to sum on the Activity to reach the target amount.

  • amount

    number

    The chosen number to reach for completion of the Promotion.

+

  • type

    string

    Can be count or sum. count if the progress should be incremented by 1 each time. sum if the progress should be summed from the specified field property.

  • field

    string

    Only supplied if type is sum. This denotes which field to sum on the Event  API  to reach the target amount.

  • amount

    number

    The chosen number to reach for completion of the Promotion.

Promotion Reward Model

Attributes

Promotion Condition Model

Attributes

  • field

    string

    The field to look at in the Activity object.

  • value

    string

    The value that the field must satisfy depending on the operator.

  • operator

    string

    The operator to use when looking at the value of the field. Can be equals, not, greater-than, less-than.

+

  • field

    string

    The field to look at in the Event  API  object.

  • value

    string

    The value that the field must satisfy depending on the operator.

  • operator

    string

    The operator to use when looking at the value of the field. Can be equals, not, greater-than, less-than.

POST/api/loyalty-programs/{id}/promotions

Create Promotion experimental

Attributes

  • name

    stringrequired

    The display name of the Promotion.

  • description

    string

    The display description for the Promotion.

  • mediaUploadId

    string

    The ID of the Media Upload  API  image of the Promotion.

  • startsAt

    timestamp

    The timestamp of when the Promotion starts.

  • endsAt

    timestamp

    The timestamp of when the Promotion ends.

  • rewards

    arrayrequired

    A list of Rewards  API  that the account will receive upon completing the Promotion.

  • eventType

    stringrequired

    The type of Event  API  that will trigger increments and completions of the Promotion.

  • target

    object

    Describes how to complete the promotion. See Promotion Target  API .

  • type

    stringrequired

    The type of Promotion. Can be cashback or challenge. challenge rewards the account once, after the challenge target is met. cashback gives a reward based on the payment amount, which can be completed an unlimited number of times.

  • conditions

    array

    The list of Conditions  API  that need to be met when incrementing/completing the Promotion.

Errors

  • name

    stringrequired

    The display name of the Promotion.

  • description

    string

    The display description for the Promotion.

  • mediaUploadId

    string

    The ID of the Media Upload  API  image of the Promotion.

  • startsAt

    timestamp

    The timestamp of when the Promotion starts.

  • endsAt

    timestamp

    The timestamp of when the Promotion ends.

  • rewards

    arrayrequired

    A list of Rewards  API  that the account will receive upon completing the Promotion.

  • eventType

    stringrequired

    The type of Event  API  that will trigger increments and completions of the Promotion.

  • target

    object

    Describes how to complete the promotion. See Promotion Target  API .

  • type

    stringrequired

    The type of Promotion. Can be cashback or challenge. challenge rewards the account once, after the challenge target is met. cashback gives a reward based on the payment amount, which can be completed an unlimited number of times.

  • conditions

    array

    The list of Conditions  API  that need to be met when incrementing/completing the Promotion.

Errors

  • PROMOTION_REWARDS_INVALID

    403

    One or more of the rewards ledgers does not exist or permissions are invalid.

Request
POST/api/loyalty-programs/WRhAxxWpTKb5U7pXyxQjjY/promotions
curl -X POST \
  https://service.centrapay.com/api/loyalty-programs/WRhAxxWpTKb5U7pXyxQjjY/promotions \
diff --git a/api/quotas/index.html b/api/quotas/index.html
index 2cdf47bce..2f1c54252 100644
--- a/api/quotas/index.html
+++ b/api/quotas/index.html
@@ -19,7 +19,7 @@
 
 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs 
Go to home page
 Docs