Versions Compared

Old Version 1

changes.mady.by.user p_demou (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user George Rossides

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Type

Description

id

String

The ID of the retrieved promotion campaign

nameStringThe name of the retrieved promotion campaign
alternative_codeStringThe alternative code of the retrieved promotion campaign
descriptionStringThe description of the retrieved promotion campaign
long_descriptionStringThe long description of the retrieved promotion campaign
short_descriptionStringThe short description of the retrieved promotion campaign
life_cycle_stateString

The life cycle state of the retrieved promotion campaign. Available options are:

  • DRAFT
  • POSTED
typeString

The type of the retrieved promotion campaign. Available options are:

  • DISCOUNT_PROMOTION
  • REWARD_PROMOTION
distribution_methodString

The distribution method of the retrieved promotion campaign. Available options are:

  • INSTANT
  • UPON_REQUEST
allowed_redemption_actionsString

The allowed redemption subscription actions which the promo code can be redeemed on. Available options are:

  • BECOME_SUBSCRIBER
  • ACTIVATE_SUBSCRIPTION
  • ACTIVATE_SERVICE
  • ADD_SERVICE
  • UPGRADE_SERVICE
    • ADD_SERVICE_USAGEapplicable_on_new_subscribers    		BooleanDefines whether the promo codes of the retrieved promotion campaign, will be able to be used during creating a new subscribers
    applicable_on_existing_subscribersBooleanDefines whether the promo codes of the retrieved promotion campaign, will be able to be used on an existing subscribers
    applicable_on_purchase_customer_eventsBoolean

    Defines whether the promo codes of the retrieved promotion campaign, will be able to be used on a purchase customer event

    Tip

    Available from CRM.COM R15.0.0

    applicable_on_referral_customer_eventsBoolean

    Defines whether the promo codes of the retrieved promotion campaign, will be able to be used on a referral customer event

    Tip

    Available from CRM.COM R15.0.0

    applicable_on_achievement_customer_eventsBoolean

    Defines whether the promo codes of the retrieved promotion campaign, will be able to be used on an achievement customer event

    Tip

    Available from CRM.COM R15.0.0

    additive_discount_definitionAdditive Discount Definition ObjectThe Ad Hoc Discount Definition related to the retrieved promotion campaign
    communication_templateCommunication Template ObjectThe Communication Template related to the retrieved promotion campaign

    log_information

    Log Information Object

    The log information related with the retrieved promotion campaign

    ...

    Anchor
    promotion campaign referred objects
    promotion campaign referred objects
    Referred Objects Response Data

    Include Page
    additive_discount_definition_short
    additive_discount_definition_short
    Include Page
    communication_template_completecommunication_template_complete

    Include Page
    log_information_short
    log_information_short