Versions Compared

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
distribution_methodString

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

  • INSTANT
  • UPON_REQUEST
allowedapplicable_on_redemptionnew_actionssubscriberString

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_USAGE
BooleanDefines whether the promo codes of the retrieved promotion campaign, will be able to be redeemed during creating a new subscriber
applicable_on_existing_subscriberBooleanDefines whether the promo codes of the retrieved promotion campaign, will be able to be redeemed on an existing subscriber
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

...

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

...