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

Add Email Lead

Adds an email lead and/or will call the 3rd party subscription methods registered with group commerce.  The additional fields can be used to drive 3rd party subscription service behavior.

Method: POST /api/v3/publisher/emaillead

Authentication: oauth
 
Post
Required Form Name Data Type Explanation
Yes
EmailAddress string The email address to record.
No
FirstName
string The first name to record.
No LastName string The last name to record.
No ZipCode string The zip code to record.  For some publishers this is a required field.
No SegmentKey string The segment key to record.  For some publishers this is a required field.
NoSourcingPartnerKey
string
The sourcing partner to associate this email lead with.
No
SendEmail
bool
If true, a subscription verification email will be sent to the subscriber (true by default)
No AffiliateInfo.AffiliateId int When recording affiliate tracking, the id of the affiliate.
No AffiliateInfo.AffiliateSource string When recording affiliate tracking, the source of the affiliate.
No AffiliateInfo.CreateUnixTimestamp int64 When recording affiliate tracking, the Unix time or POSIX time the affiliate tracking started recording. 
No AdditionalFields[0...n].Key string The list of keys for the additional fields, useful for recording additional information to a 3rd party api.  This data is not recorded in the GroupCommerce email tables.
No AdditionalFields[0...n].Value string The list of values for the additional fields, useful for recording additional information to a 3rd party api.  This data is not recorded in the GroupCommerce email tables.
NoExternalUserIdstringAn external id that can be used to identify this user.

Returns
base response fields


Sample Request:

POST http://api.groupcommerce.com/api/v3/publisher/emaillead

Form: EmailAddress=test%40groupcommerce.com&ZipCode=10001&FirstName=Sylvester&LastName=Martin&SegmentKey=national&AdditionalFields%5b0%5d.Key=key1&AdditionalFields%5b0%5d.Value=value1

OAuth oauth_signature="2MWlWU%2btdoSAkpbbChbRJqHC3eg%3d", oauth_nonce="9005909", oauth_timestamp="1319762439", 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:

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