Versions Compared

Old Version 1

changes.mady.by.user p_demou (Deactivated)

Saved on

compared with

New Version Current

changes.mady.by.user p_demou (Deactivated)

Saved on

Key

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

...

...

...

...

...

...


Tip

Available from CRM.COM R14.2.0


Excerpt

This method provides the ability to request a promo code out of a specific promotion campaign

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

promotion_campaign_identifier

(

mandatory

semi-optional with promo_code)

Promotion Campaign Identifier

The identifier of the promotion campaign that will provide the promo code. Only POSTED promotion campaigns of type "Promotion Discount" and Distribution method "UPON REQUEST" are allowed.

The allowed promotion campaign identifier fields are the following:

Include Page
V4:promotion_campaign_identifier
V4:promotion_campaign_identifier

promo_code

(semi-optional with promotion_campaign_identifier)

String

The actual promo code that will be assigned on the customer. Only promo codes which are EFFECTIVE, and have been generated through a communication campaign with distribution method "UPON REQUEST" can be provided here.

Tip

Available from CRM.COM R14.19.0


contact_information_identifier

(semi-optional)

Contact Information Identifier

The identifier of the contact information that will receive the promo code. The allowed contact information identifier fields are the following:

Include Page
V4:contact_information_identifier
V4:contact_information_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the accounts receivable that will receive the promo code. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

subscription_identifier

(semi-optional)

Subscription Identifier

The identifier of the subscription that will receive the promo code. The allowed subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The identifier of the rewards participant that will receive the promo code. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier_post
V4:rewards_participants_identifier_post

Tip

Deprecated from CRM.COM R17.0.0


fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...

Expand
titleExample 1

HTTP Method: POST

Request:

Body:

Code Block
languagejavascript
themeConfluence
languagejavascript
linenumberstrue
 
 
{
    "token":"{{token}}",
    "promotion_campaign_identifier": { "alternative_code" : "BG4"},
    "rewards_participant_identifier": { "number" : "RP0000000618"}
}


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 

 

...

{
    "data": {
        "code": "SC4dcj1p4sathzZ",
        "promotion_campaign": {
            "short_description": null,
            "alternative_code": "BG4",
            "name": "Bulk Generation 4",
            "description": null,
            "id": "DDA3E17570FE4BEFB1550BD1C63389E7",
            "long_description": null,
            "type": "DISCOUNT_PROMOTION"
        },
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2018-07-25T16:52:01",
            "updated_date": "2018-07-25T18:07:45",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "test@crm.com",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "MPAdministrator",
                "id": "1",
                "username": "MPAdministrator"
            }
        },
        "id": "7EC78A3B3A8E4C3B9ED3EA5E394AD4EB",
        "life_cycle_state": "EFFECTIVE",
        "expiration_date": "2019-02-28T00:00:00"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}