Skip to end of banner
Go to start of banner

promotion_campaign_complete

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

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
applicable_on_new_subscribersBooleanDefines 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_eventsBooleanDefines whether the promo codes of the retrieved promotion campaign, will be able to be used on a purchase customer event
applicable_on_referral_customer_eventsBooleanDefines whether the promo codes of the retrieved promotion campaign, will be able to be used on a referral customer event
applicable_on_achievement_customer_eventsBooleanDefines whether the promo codes of the retrieved promotion campaign, will be able to be used on an achievement customer event
additive_discount_definitionAdditive Discount Definition ObjectThe Ad Hoc Discount Definition related to the retrieved promotion campaign

log_information

Log Information Object

The log information related with the retrieved promotion campaign

Referred Objects Response Data

 additive_discount_definition object response data

Name

Type

Description

id

String

The ID of the retrieved additive discount definition

alternative_codeStringThe alternative code of the retrieved additive discount definition
nameStringThe name of the retrieved additive discount definition
life_cycle_stateString

The life cycle state of the retrieved additive discount definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE

classificationString

The classification of the retrieved additive discount definition which can be either SUBSCRIPTIONS, JOBS or GENERAL

GENERAL classification available from CRM.COM R15.0.0

JOB classification is not available from CRM.COM R17.0.0

typeStringThe type of the additive discount definition which can be AUTO_APPLY or AD_HOC

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

updated_by_unit

Unit Object

The last unit that updated the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

  • No labels