POST api/members

Creates a new member and adds it to a referral program.

Request Information

URI Parameters

Query String: shouldSendEmail={shouldSendEmail}

Name	Description	Type	Additional information
shouldSendEmail	Set the value to true if the member should get the program's welcome email. Optional.	boolean	Default value is False

Body Parameters

A list of required structures containing information about the member to add to a referral program.

Type: NewMember

Name	Description	Type	Additional information
programId	The ID of the referral program to which the member will be added.	string	Required
firstName		string	Required
lastName	Optional	string	None.
email		string	Required
referralCode	Optional	string	None.
phone	Phone	string	None.
externalIdentifier	An alternative ID provided to help link the member to relevant data in external systems. Optional.	string	None.
dateOfBirth	Optional	date	None.
addressLine1	Optional	string	None.
addressLine2	Optional	string	None.
city	Optional	string	None.
countrySubdivision	A subdivision of a country, such as a state or province.	string	None.
country	Optional	string	None.
postalCode	Optional	string	None.
password	Optional	string	None.
disabledFlag	This flag is set if the member is NOT enabled for use in referral programs. Optional.	boolean	None.
payoutInfo	Optional.	MemberPayoutInfo	None.
customOption1Name	Custom Option 1 Name. Optional.	string	None.
customOption1Value	Custom Option 1 Value. Optional.	string	None.
customText1Name	Custom Text 1 Name. Optional.	string	None.
customText1Value	Custom Text 1 Value. Optional.	string	None.
customText2Name	Custom Text 2 Name. Optional.	string	None.
customText2Value	Custom Text 2 Value. Optional.	string	None.
customOverrideURL	Custom Override URL. Optional.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "programId": "sample string 1",
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "email": "sample string 4",
  "referralCode": "sample string 5",
  "phone": "sample string 6",
  "externalIdentifier": "sample string 7",
  "dateOfBirth": "2024-04-23T11:42:17.4965563Z",
  "addressLine1": "sample string 8",
  "addressLine2": "sample string 9",
  "city": "sample string 10",
  "countrySubdivision": "sample string 11",
  "country": "sample string 12",
  "postalCode": "sample string 13",
  "password": "sample string 14",
  "disabledFlag": true,
  "payoutInfo": {
    "payoutType": "sample string 1",
    "useDefaultValues": true,
    "email": "sample string 3"
  },
  "customOption1Name": "sample string 15",
  "customOption1Value": "sample string 16",
  "customText1Name": "sample string 17",
  "customText1Value": "sample string 18",
  "customText2Name": "sample string 19",
  "customText2Value": "sample string 20",
  "customOverrideURL": "sample string 21"
}

application/xml, text/xml

Sample:

<newMember xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <addressLine1>sample string 8</addressLine1>
  <addressLine2>sample string 9</addressLine2>
  <city>sample string 10</city>
  <country>sample string 12</country>
  <countrySubdivision>sample string 11</countrySubdivision>
  <customOption1Name>sample string 15</customOption1Name>
  <customOption1Value>sample string 16</customOption1Value>
  <customOverrideURL>sample string 21</customOverrideURL>
  <customText1Name>sample string 17</customText1Name>
  <customText1Value>sample string 18</customText1Value>
  <customText2Name>sample string 19</customText2Name>
  <customText2Value>sample string 20</customText2Value>
  <dateOfBirth>2024-04-23T11:42:17.4965563+00:00</dateOfBirth>
  <disabledFlag>true</disabledFlag>
  <email>sample string 4</email>
  <externalIdentifier>sample string 7</externalIdentifier>
  <firstName>sample string 2</firstName>
  <lastName>sample string 3</lastName>
  <password>sample string 14</password>
  <payoutInfo>
    <email>sample string 3</email>
    <payoutType>sample string 1</payoutType>
    <useDefaultValues>true</useDefaultValues>
  </payoutInfo>
  <phone>sample string 6</phone>
  <postalCode>sample string 13</postalCode>
  <referralCode>sample string 5</referralCode>
  <programId>sample string 1</programId>
</newMember>

Response Information

Resource Description

[HTTP Status 201 - Created]

Type: MemberConfirmation

Name	Description	Type	Additional information
member	Structure containing details about the member.	Member	None.
message	The message provides more information about the results of the client's request. Review this field for error information.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "message": "sample string 1",
  "member": {
    "id": "294d519f-8e9d-4925-9b01-0e9b030b1689",
    "displayName": "sample string 1",
    "firstName": "sample string 2",
    "lastName": "sample string 3",
    "email": "sample string 4",
    "phone": "sample string 5",
    "externalIdentifier": "sample string 6",
    "dateOfBirth": "2024-04-23T11:42:17.4965563Z",
    "addressLine1": "sample string 7",
    "addressLine2": "sample string 8",
    "city": "sample string 9",
    "countrySubdivision": "sample string 10",
    "country": "sample string 11",
    "postalCode": "sample string 12",
    "disabledFlag": true,
    "customOverrideURL": "sample string 13",
    "payoutInfo": {
      "payoutType": "sample string 1",
      "useDefaultValues": true,
      "email": "sample string 3"
    },
    "customOption1Name": "sample string 14",
    "customOption1Value": "sample string 15",
    "customText1Name": "sample string 16",
    "customText1Value": "sample string 17",
    "customText2Name": "sample string 18",
    "customText2Value": "sample string 19",
    "programId": "5e23f579-0394-403d-8536-28e0684e71fb",
    "programTitle": "sample string 21",
    "programName": "sample string 22",
    "referralUrl": "sample string 24",
    "referralCode": "sample string 23",
    "memberUrl": "sample string 25",
    "emailShares": 26,
    "socialShares": 27,
    "views": 28,
    "referrals": 29,
    "lastShare": "2024-04-23T11:42:17.4965563Z",
    "referralsApproved": 30,
    "referralsQualified": 31,
    "referralsPending": 32,
    "referralsApprovedAmount": 33.0,
    "rewardsPendingAmount": 34.0,
    "rewardsIssuedAmount": 35.0,
    "rewardAmountTotal": 36.0,
    "rewards": 37,
    "createDt": "2024-04-23T11:42:17.4965563Z",
    "utmSource": "sample string 38",
    "utmMedium": "sample string 39",
    "utmCampaign": "sample string 40",
    "browserReferrerUrl": "sample string 41",
    "lastViewIPAddress": "sample string 42"
  }
}

application/xml, text/xml

Sample:

<memberConfirmation xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <message>sample string 1</message>
  <member>
    <id>294d519f-8e9d-4925-9b01-0e9b030b1689</id>
    <displayName>sample string 1</displayName>
    <firstName>sample string 2</firstName>
    <lastName>sample string 3</lastName>
    <email>sample string 4</email>
    <phone>sample string 5</phone>
    <externalIdentifier>sample string 6</externalIdentifier>
    <dateOfBirth>2024-04-23T11:42:17.4965563+00:00</dateOfBirth>
    <addressLine1>sample string 7</addressLine1>
    <addressLine2>sample string 8</addressLine2>
    <city>sample string 9</city>
    <countrySubdivision>sample string 10</countrySubdivision>
    <country>sample string 11</country>
    <postalCode>sample string 12</postalCode>
    <disabledFlag>true</disabledFlag>
    <customOverrideURL>sample string 13</customOverrideURL>
    <payoutInfo>
      <email>sample string 3</email>
      <payoutType>sample string 1</payoutType>
      <useDefaultValues>true</useDefaultValues>
    </payoutInfo>
    <customOption1Name>sample string 14</customOption1Name>
    <customOption1Value>sample string 15</customOption1Value>
    <customText1Name>sample string 16</customText1Name>
    <customText1Value>sample string 17</customText1Value>
    <customText2Name>sample string 18</customText2Name>
    <customText2Value>sample string 19</customText2Value>
    <programId>5e23f579-0394-403d-8536-28e0684e71fb</programId>
    <programTitle>sample string 21</programTitle>
    <programName>sample string 22</programName>
    <referralUrl>sample string 24</referralUrl>
    <referralCode>sample string 23</referralCode>
    <memberUrl>sample string 25</memberUrl>
    <emailShares>26</emailShares>
    <socialShares>27</socialShares>
    <views>28</views>
    <referrals>29</referrals>
    <lastShare>2024-04-23T11:42:17.4965563+00:00</lastShare>
    <referralsApproved>30</referralsApproved>
    <referralsQualified>31</referralsQualified>
    <referralsPending>32</referralsPending>
    <referralsApprovedAmount>33</referralsApprovedAmount>
    <rewardsPendingAmount>34</rewardsPendingAmount>
    <rewardsIssuedAmount>35</rewardsIssuedAmount>
    <rewardAmountTotal>36</rewardAmountTotal>
    <rewards>37</rewards>
    <createDt>2024-04-23T11:42:17.4965563+00:00</createDt>
    <utmSource>sample string 38</utmSource>
    <utmMedium>sample string 39</utmMedium>
    <utmCampaign>sample string 40</utmCampaign>
    <browserReferrerUrl>sample string 41</browserReferrerUrl>
    <lastViewIPAddress>sample string 42</lastViewIPAddress>
  </member>
</memberConfirmation>