Advocate Enrollment | Referral Marketing Developer Guide

This action is available in API version 64.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/enrollAdvocateB2bReferralProm
Formats: JSON
HTTP Methods: POST
Authentication: Authorization: Bearer Token

Inputs

Input	Details
programName	Type String Description Required. Loyalty program name associated with the promotion.
promotionId	Type String Description Promotion ID of the promotion. The account is enrolled as an advocate for this promotion.
promotionCode	Type String Description Promotion code used to enroll accounts as an advocate in this promotion.
accountId	Type String Description Account ID of the account that is going to be enrolled as an advocate.
memberStatus	Type String Description Status of the new advocate after enrollment is completed.
membershipNumber	Type String Description Membership number of the account that is enrolled as a loyalty program member.
referralFirstName	Type String Description The first name of the referral who signed up to be a customer, or to make a purchase.
enrollmentChannel	Type String Description Channel used by the advocate to join the referral program.

Outputs

Output	Details
programName	Type String Description Required. Loyalty program name associated with the promotion.
promotionCode	Type String Description Promotion code used to enroll accounts as an advocate in this promotion.
memberId	Type String Description Promotion code used to enroll accounts as an advocate in this promotion.
accountId	Type String Description Account ID of the account that is going to be enrolled as an advocate.
membershipNumber	Type String Description Membership number of the account that is enrolled as a loyalty program member.
transactionJournalIds	Type String Description The comma separate list of transaction journal IDs created for target member enrollment.

Example

Sample Request

1{
2   "inputs":[
3      {
4         "programName": "demo",
5         "promotionId": "0c8xx00000001NVAAY",
6         "accountId": "001xx000003Ge63AAC"
7 }
8 ]
9}

Sample Response

1
2{
3"actionName": "enrollAdvocateB2bReferralProm",
4"errors": null,
5"invocationId": null,
6"isSuccess": true,
7"outcome": null,
8"outputValues": {
9"membershipNumber": "BTMADV1",
10"accountId": "001xx000003Ge63AAC",
11"programName": "RP01",
12"referralCode": "PN4SCF73-RPT01",
13"promotionCode": "RPT01",
14"transactionJournals": [
15"0lVxx00000001SL"
16],
17"memberId": "0lMxx00000000Mb"
18},
19"sortOrder": -1,
20"version": 1
21}
22]