POST api/members/update

Updates members of a referral program. For each member, a query object is specified to identify the member to update and a member object is specified to identify the elements to update. At a minimum, a query object requires either a valid value in primaryInfo or a valid element in both the secondaryInfo and tertiaryInfo elements. A member will only be updated if it can be uniquely identifier by the query.

Request Information

URI Parameters

Query String:

None.

Body Parameters

A list of required structures containing details about the member to update.

Type: Collection of UpdateMemberInfo

NameDescriptionTypeAdditional information
query

A structure containing details to identify a member to update.

MemberQuery

Required

member

A structure containing the elements of a member to update.

UpdateMember

Required

Request Formats

application/json, text/json

Sample:
[
  {
    "query": {
      "primaryInfo": {
        "memberId": "sample string 1",
        "referralCode": "sample string 2"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2"
      },
      "tertiaryInfo": {
        "programId": "sample string 1",
        "programName": "sample string 2",
        "programTitle": "sample string 3"
      }
    },
    "member": {
      "firstName": "sample string 1",
      "lastName": "sample string 2",
      "email": "sample string 3",
      "referralCode": "sample string 4",
      "phone": "sample string 5",
      "externalIdentifier": "sample string 6",
      "dateOfBirth": "2018-04-22T04:21:38.7392625Z",
      "addressLine1": "sample string 7",
      "addressLine2": "sample string 8",
      "city": "sample string 9",
      "countrySubdivision": "sample string 10",
      "country": "sample string 11",
      "postalCode": "sample string 12",
      "password": "sample string 13",
      "disabledFlag": true,
      "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",
      "customOverrideURL": "sample string 20"
    }
  },
  {
    "query": {
      "primaryInfo": {
        "memberId": "sample string 1",
        "referralCode": "sample string 2"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2"
      },
      "tertiaryInfo": {
        "programId": "sample string 1",
        "programName": "sample string 2",
        "programTitle": "sample string 3"
      }
    },
    "member": {
      "firstName": "sample string 1",
      "lastName": "sample string 2",
      "email": "sample string 3",
      "referralCode": "sample string 4",
      "phone": "sample string 5",
      "externalIdentifier": "sample string 6",
      "dateOfBirth": "2018-04-22T04:21:38.7392625Z",
      "addressLine1": "sample string 7",
      "addressLine2": "sample string 8",
      "city": "sample string 9",
      "countrySubdivision": "sample string 10",
      "country": "sample string 11",
      "postalCode": "sample string 12",
      "password": "sample string 13",
      "disabledFlag": true,
      "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",
      "customOverrideURL": "sample string 20"
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfupdateMember xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <updateMember>
    <member>
      <addressLine1>sample string 7</addressLine1>
      <addressLine2>sample string 8</addressLine2>
      <city>sample string 9</city>
      <country>sample string 11</country>
      <countrySubdivision>sample string 10</countrySubdivision>
      <customOption1Name>sample string 14</customOption1Name>
      <customOption1Value>sample string 15</customOption1Value>
      <customOverrideURL>sample string 20</customOverrideURL>
      <customText1Name>sample string 16</customText1Name>
      <customText1Value>sample string 17</customText1Value>
      <customText2Name>sample string 18</customText2Name>
      <customText2Value>sample string 19</customText2Value>
      <dateOfBirth>2018-04-22T00:21:38.7392625-04:00</dateOfBirth>
      <disabledFlag>true</disabledFlag>
      <email>sample string 3</email>
      <externalIdentifier>sample string 6</externalIdentifier>
      <firstName>sample string 1</firstName>
      <lastName>sample string 2</lastName>
      <password>sample string 13</password>
      <payoutInfo>
        <email>sample string 3</email>
        <payoutType>sample string 1</payoutType>
        <useDefaultValues>true</useDefaultValues>
      </payoutInfo>
      <phone>sample string 5</phone>
      <postalCode>sample string 12</postalCode>
      <referralCode>sample string 4</referralCode>
    </member>
    <query>
      <primaryInfo>
        <memberId>sample string 1</memberId>
        <referralCode>sample string 2</referralCode>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
      </secondaryInfo>
      <tertiaryInfo>
        <programId>sample string 1</programId>
        <programName>sample string 2</programName>
        <programTitle>sample string 3</programTitle>
      </tertiaryInfo>
    </query>
  </updateMember>
  <updateMember>
    <member>
      <addressLine1>sample string 7</addressLine1>
      <addressLine2>sample string 8</addressLine2>
      <city>sample string 9</city>
      <country>sample string 11</country>
      <countrySubdivision>sample string 10</countrySubdivision>
      <customOption1Name>sample string 14</customOption1Name>
      <customOption1Value>sample string 15</customOption1Value>
      <customOverrideURL>sample string 20</customOverrideURL>
      <customText1Name>sample string 16</customText1Name>
      <customText1Value>sample string 17</customText1Value>
      <customText2Name>sample string 18</customText2Name>
      <customText2Value>sample string 19</customText2Value>
      <dateOfBirth>2018-04-22T00:21:38.7392625-04:00</dateOfBirth>
      <disabledFlag>true</disabledFlag>
      <email>sample string 3</email>
      <externalIdentifier>sample string 6</externalIdentifier>
      <firstName>sample string 1</firstName>
      <lastName>sample string 2</lastName>
      <password>sample string 13</password>
      <payoutInfo>
        <email>sample string 3</email>
        <payoutType>sample string 1</payoutType>
        <useDefaultValues>true</useDefaultValues>
      </payoutInfo>
      <phone>sample string 5</phone>
      <postalCode>sample string 12</postalCode>
      <referralCode>sample string 4</referralCode>
    </member>
    <query>
      <primaryInfo>
        <memberId>sample string 1</memberId>
        <referralCode>sample string 2</referralCode>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
      </secondaryInfo>
      <tertiaryInfo>
        <programId>sample string 1</programId>
        <programName>sample string 2</programName>
        <programTitle>sample string 3</programTitle>
      </tertiaryInfo>
    </query>
  </updateMember>
</ArrayOfupdateMember>

Response Information

Resource Description

[HTTP Status 200 - OK]

Type: Collection of UpdateMemberResult

NameDescriptionTypeAdditional information
query

Echos the query sent in the request.

MemberQuery

None.

member

The member, reflecting updates made by the request.

Member

None.

resultInfo

Details about the results of the request.

ResultInfo

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "query": {
      "primaryInfo": {
        "memberId": "sample string 1",
        "referralCode": "sample string 2"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2"
      },
      "tertiaryInfo": {
        "programId": "sample string 1",
        "programName": "sample string 2",
        "programTitle": "sample string 3"
      }
    },
    "member": {
      "id": "94a4a45d-8ea9-4955-8c4b-92879a2957a2",
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "email": "sample string 4",
      "phone": "sample string 5",
      "externalIdentifier": "sample string 6",
      "dateOfBirth": "2018-04-22T04:21:38.7662567Z",
      "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": "23cb9270-cb1a-4db8-9098-451e78058955",
      "programTitle": "sample string 21",
      "programName": "sample string 22",
      "referralCode": "sample string 23",
      "referralUrl": "sample string 24",
      "memberUrl": "sample string 25",
      "emailShares": 26,
      "socialShares": 27,
      "views": 28,
      "referrals": 29,
      "lastShare": "2018-04-22T04:21:38.7662567Z",
      "referralsApproved": 30,
      "referralsQualified": 31,
      "referralsApprovedAmount": 32.0,
      "rewardsPendingAmount": 33.0,
      "rewardsIssuedAmount": 34.0,
      "createDt": "2018-04-22T04:21:38.7662567Z"
    },
    "resultInfo": {
      "Status": "sample string 1",
      "Message": "sample string 2"
    }
  },
  {
    "query": {
      "primaryInfo": {
        "memberId": "sample string 1",
        "referralCode": "sample string 2"
      },
      "secondaryInfo": {
        "externalIdentifier": "sample string 1",
        "email": "sample string 2"
      },
      "tertiaryInfo": {
        "programId": "sample string 1",
        "programName": "sample string 2",
        "programTitle": "sample string 3"
      }
    },
    "member": {
      "id": "94a4a45d-8ea9-4955-8c4b-92879a2957a2",
      "firstName": "sample string 2",
      "lastName": "sample string 3",
      "email": "sample string 4",
      "phone": "sample string 5",
      "externalIdentifier": "sample string 6",
      "dateOfBirth": "2018-04-22T04:21:38.7662567Z",
      "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": "23cb9270-cb1a-4db8-9098-451e78058955",
      "programTitle": "sample string 21",
      "programName": "sample string 22",
      "referralCode": "sample string 23",
      "referralUrl": "sample string 24",
      "memberUrl": "sample string 25",
      "emailShares": 26,
      "socialShares": 27,
      "views": 28,
      "referrals": 29,
      "lastShare": "2018-04-22T04:21:38.7662567Z",
      "referralsApproved": 30,
      "referralsQualified": 31,
      "referralsApprovedAmount": 32.0,
      "rewardsPendingAmount": 33.0,
      "rewardsIssuedAmount": 34.0,
      "createDt": "2018-04-22T04:21:38.7662567Z"
    },
    "resultInfo": {
      "Status": "sample string 1",
      "Message": "sample string 2"
    }
  }
]

application/xml, text/xml

Sample:
<ArrayOfupdateMemberResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <updateMemberResult>
    <member>
      <id>94a4a45d-8ea9-4955-8c4b-92879a2957a2</id>
      <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>2018-04-22T00:21:38.7662567-04: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>
      <customOverrideURL>sample string 13</customOverrideURL>
      <disabledFlag>true</disabledFlag>
      <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>23cb9270-cb1a-4db8-9098-451e78058955</programId>
      <programTitle>sample string 21</programTitle>
      <programName>sample string 22</programName>
      <referralCode>sample string 23</referralCode>
      <referralUrl>sample string 24</referralUrl>
      <memberUrl>sample string 25</memberUrl>
      <emailShares>26</emailShares>
      <socialShares>27</socialShares>
      <views>28</views>
      <referrals>29</referrals>
      <lastShare>2018-04-22T00:21:38.7662567-04:00</lastShare>
      <referralsApproved>30</referralsApproved>
      <referralsQualified>31</referralsQualified>
      <referralsApprovedAmount>32</referralsApprovedAmount>
      <rewardsPendingAmount>33</rewardsPendingAmount>
      <rewardsIssuedAmount>34</rewardsIssuedAmount>
      <createDt>2018-04-22T00:21:38.7662567-04:00</createDt>
    </member>
    <query>
      <primaryInfo>
        <memberId>sample string 1</memberId>
        <referralCode>sample string 2</referralCode>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
      </secondaryInfo>
      <tertiaryInfo>
        <programId>sample string 1</programId>
        <programName>sample string 2</programName>
        <programTitle>sample string 3</programTitle>
      </tertiaryInfo>
    </query>
    <resultInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Response">
      <d3p1:Message>sample string 2</d3p1:Message>
      <d3p1:Status>sample string 1</d3p1:Status>
    </resultInfo>
  </updateMemberResult>
  <updateMemberResult>
    <member>
      <id>94a4a45d-8ea9-4955-8c4b-92879a2957a2</id>
      <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>2018-04-22T00:21:38.7662567-04: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>
      <customOverrideURL>sample string 13</customOverrideURL>
      <disabledFlag>true</disabledFlag>
      <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>23cb9270-cb1a-4db8-9098-451e78058955</programId>
      <programTitle>sample string 21</programTitle>
      <programName>sample string 22</programName>
      <referralCode>sample string 23</referralCode>
      <referralUrl>sample string 24</referralUrl>
      <memberUrl>sample string 25</memberUrl>
      <emailShares>26</emailShares>
      <socialShares>27</socialShares>
      <views>28</views>
      <referrals>29</referrals>
      <lastShare>2018-04-22T00:21:38.7662567-04:00</lastShare>
      <referralsApproved>30</referralsApproved>
      <referralsQualified>31</referralsQualified>
      <referralsApprovedAmount>32</referralsApprovedAmount>
      <rewardsPendingAmount>33</rewardsPendingAmount>
      <rewardsIssuedAmount>34</rewardsIssuedAmount>
      <createDt>2018-04-22T00:21:38.7662567-04:00</createDt>
    </member>
    <query>
      <primaryInfo>
        <memberId>sample string 1</memberId>
        <referralCode>sample string 2</referralCode>
      </primaryInfo>
      <secondaryInfo>
        <email>sample string 2</email>
        <externalIdentifier>sample string 1</externalIdentifier>
      </secondaryInfo>
      <tertiaryInfo>
        <programId>sample string 1</programId>
        <programName>sample string 2</programName>
        <programTitle>sample string 3</programTitle>
      </tertiaryInfo>
    </query>
    <resultInfo xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Response">
      <d3p1:Message>sample string 2</d3p1:Message>
      <d3p1:Status>sample string 1</d3p1:Status>
    </resultInfo>
  </updateMemberResult>
</ArrayOfupdateMemberResult>