promotion_campaign_complete

Name	Type	Description
id	String	The ID of the retrieved promotion campaign
name	String	The name of the retrieved promotion campaign
alternative_code	String	The alternative code of the retrieved promotion campaign
description	String	The description of the retrieved promotion campaign
long_description	String	The long description of the retrieved promotion campaign
short_description	String	The short description of the retrieved promotion campaign
life_cycle_state	String	The life cycle state of the retrieved promotion campaign. Available options are: DRAFT POSTED
type	String	The type of the retrieved promotion campaign. Available options are: DISCOUNT_PROMOTION REWARD_PROMOTION
distribution_method	String	The distribution method of the retrieved promotion campaign. Available options are: INSTANT UPON_REQUEST
applicable_on_new_subscribers	Boolean	Defines whether the promo codes of the retrieved promotion campaign, will be able to be used during creating a new subscribers
applicable_on_existing_subscribers	Boolean	Defines whether the promo codes of the retrieved promotion campaign, will be able to be used on an existing subscribers
applicable_on_purchase_customer_events	Boolean	Defines whether the promo codes of the retrieved promotion campaign, will be able to be used on a purchase customer event Available from CRM.COM R15.0.0
applicable_on_referral_customer_events	Boolean	Defines whether the promo codes of the retrieved promotion campaign, will be able to be used on a referral customer event Available from CRM.COM R15.0.0
applicable_on_achievement_customer_events	Boolean	Defines whether the promo codes of the retrieved promotion campaign, will be able to be used on an achievement customer event Available from CRM.COM R15.0.0
additive_discount_definition	Additive Discount Definition Object	The 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_code	String	The alternative code of the retrieved additive discount definition
name	String	The name of the retrieved additive discount definition
life_cycle_state	String	The life cycle state of the retrieved additive discount definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE
classification	String	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
type	String	The 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
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The 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