diff --git a/api/account-memberships/index.html b/api/account-memberships/index.html index 54113aa35..496a6124e 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

Promotion Memberships

Promotion Memberships represents an Account’s  API  membership to a Promotion  API . Each Promotion Membership carries progress towards completing the Promotion. Promotion Memberships are created automatically for the account when a Loyalty Program Membership  API  is created.

+

Promotion Memberships

Promotion Memberships represents an Account’s  API  membership to a Promotion  API . Each Promotion Membership carries progress towards completing the Promotion. Promotion Memberships are created automatically for the account when a Loyalty Program Membership  API  is created.

Promotion Membership Model

Attributes

  • id

    string

    The unique identifier for the Promotion.

  • accountId

    string

    The ID of the Account  API  that owns the Promotion.

  • name

    string

    The display name of the Promotion.

  • programId

    string

    The ID of the Loyalty Program  API  that the Promotion belongs to.

  • summary

    string

    The display summary for the Promotion.

  • mediaUploadId

    string

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

  • img

    string

    The img URL of the Promotion.

  • startsAt

    timestamp

    The timestamp of when the Promotion starts.

  • endsAt

    timestamp

    The timestamp of when the Promotion ends.

  • rewards

    array

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

  • eventType

    string

    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

    string

    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.

  • description

    string

    Displayable description for the Promotion.

  • progress

    number

    The Account’s progress towards completing the Promotion.

  • status

    number

    The status of the Promotion Membership. Can be “active”, “expired”, or “complete”.

  • createdAt

    string

    The timestamp of when the Promotion Membership was created.

  • createdBy

    crn

    The User or API Key that created the Promotion Membership.

  • modifiedAt

    string

    The timestamp of when the Promotion Membership was last modified.

  • modifiedBy

    crn

    The User or API Key that last modified the Promotion Membership.

+

  • id

    string

    The unique identifier for the Promotion.

  • accountId

    string

    The ID of the Account  API  that owns the Promotion.

  • name

    string

    The display name of the Promotion.

  • programId

    string

    The ID of the Loyalty Program  API  that the Promotion belongs to.

  • summary

    string

    The display summary for the Promotion.

  • mediaUploadId

    string

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

  • img

    string

    The img URL of the Promotion.

  • startsAt

    timestamp

    The timestamp of when the Promotion starts.

  • endsAt

    timestamp

    The timestamp of when the Promotion ends.

  • rewards

    array

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

  • eventType

    string

    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

    string

    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.

  • description

    string

    Displayable description for the Promotion.

  • progress

    number

    The Account’s progress towards completing the Promotion.

  • status

    number

    The status of the Promotion Membership. Can be “active”, “expired”, or “complete”.

  • createdAt

    string

    The timestamp of when the Promotion Membership was created.

  • createdBy

    crn

    The User or API Key that created the Promotion Membership.

  • modifiedAt

    string

    The timestamp of when the Promotion Membership was last modified.

  • modifiedBy

    crn

    The User or API Key that last modified the Promotion Membership.

  • test

    boolean

    true if the promotion membership is for testing purposes only.

GET/api/accounts/{id}/promotion-memberships

List Promotion Memberships by Account experimental

Returns a paginated  API  list of Promotion Memberships for an Account  API 

Request
GET/api/accounts/57SyRRgZ1U8Kq2wKpCnSR5/promotion-memberships
curl -X GET \
  https://service.centrapay.com/api/accounts/57SyRRgZ1U8Kq2wKpCnSR5/promotion-memberships \
@@ -78,7 +78,8 @@
       "modifiedAt": "2023-02-08T04:04:27.426Z",
       "modifiedBy": "crn::user:1234",
       "progress": 0,
-      "status": "active"
+      "status": "active",
+      "test": true
     }
   ]
 }
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