Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Methods‎ > ‎2 - Consumer Related‎ > ‎

Log Refer Friends

Will record the action of referring a friend for metrics reporting.  With the type you can track additional referral types other than email.  This can be used for tracking referral conversions.

Method: POST /api/v3/publisher/consumer/{referredByUserKey}/logreferfriends

Authentication: oauth

Parameters
   referredByUserKey - The UserKey of the consumer making the referral.

Post
Required Form Name Data Type Explanation
Yes
ReferralTypestring The type of referral record.  One of facebook, twitter, or email.
Yes
ReferredFriends[0...n]string
The list of friends referred.

Returns
success - Whether the refer friend action was logged.


Sample Request:

POST  https://api.groupcommerce.com/api/v3/publisher/consumer/3c651ac9e6054d72b9b938f782790c8c/logreferfriends

Form: ReferredByUserKey=3c651ac9e6054d72b9b938f782790c8c&ReferralType=Email&ReferredFriends%5B0%5D=apisupport%40groupcommerce.com&ReferredFriends%5B1%5D=fbid%3A47382923

OAuth oauth_signature="FBzavulBQGJ1V67gojTbCjHNXXA%3D", oauth_nonce="8401727", oauth_timestamp="1342160238", oauth_consumer_key="eeb6b959-b854-4ad1-b563-e801c83cf81d", oauth_signature_method="HMAC-SHA1", oauth_version="1.0"


Sample JSON Response:

{
    "errors":[],
    "lastPublished":"/Date(1319762442406)/",
    "success":true,
    "version":"3"
}


Sample XML Response:

<logReferFriendsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <errors/>
    <lastPublished>2011-10-28T00:41:46.6073105Z</lastPublished>
    <success>true</success>
    <version>3</version>
</
logReferFriendsResponse>
Comments