You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
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 |
| life_cycle_state | String | The life cycle state of the retrieved promotion campaign. Available options are: |
| type | String | The type of the retrieved promotion campaign. Available options are: |
| distribution_method | String | The distribution method of the retrieved promotion campaign. Available options are: |
| allowed_redemption_actions | String | 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
|
| additive_discount_definition | Additive Discount Definition Object | The Ad Hoc Discount Definition related to the retrieved promotion campaign |
| communication_template | Communication Template Object | The Communication Template 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 |
| type | String | The type of the additive discount definition which can be AUTO_APPLY or AD_HOC |
Name | Type | Description |
|---|
| id | String | The ID of the communication template |
| name | String | The name of the communication template |
alternative_code | String | The alternative code of the communication template |
| description | String | A description of the communication template |
| life_cycle_state | String | The life cycle state of the communication template, which can be EFFECTIVE or NOT_EFFECTIVE |
| direction | String | The direction of the communication template, which can be INCOMING or OUTGOING |
| media | String | The media of the communication template, which can be EMAIL, SMS, PHONE, LETTER, F2F |
| subject | String | The subject of the communication template |
| content | String | The content of the communication template |
| category | Communication Category Object | The category of the communication template |
| communication_queue_external_system | Communication Queue External System | The communication queue external system of the communication template |
| log_information | Log Information Object | The log information of the communication queue external system |
Referred Objects Response Data
communication_category response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved communication category |
| name | String | The Name of the retrieved communication category |
| code | String | The code of the retrieved communication category |
| description | String | The Description of the retrieved communication category |
communication_queue_external_system object response data
| | |
|---|
| Id | String | The ID of the communication queue external system |
| name | String | The name of the communication queue external system |
alternative_code | String | The alternative code of the communication queue external system |
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 |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
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 |
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 |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
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 |