Welcome‎ > ‎Version 2‎ > ‎Publisher Api (Read/Write)‎ > ‎Methods‎ > ‎4 - Email Leads‎ > ‎

Create Email Lead

This method will save an email lead to the system.  If integration with a ESP exists, the email lead will be pushed to the ESP.

Method: POST /api/v2/publisher/emailLead/

Authentication: oauth

Post
Requried Form Name Explanation
Yes
EmailAddress The email address of person joining the list
No
ZipCode The zip code of the person joining the list
No
FirstName The first name of person joining the list
No
LastName
The last name of person joining the list
No SegmentKey The segment of person joining the list


Returns:
  success - Whether or the user the consumer was added to the subscriber list.
  errors - Contains error message when success = false.

Sample Request:
POST /api/v2/publisher/emailLead/

EmailAddress=email%40email.com&FirstName=Sylvester&LastName=Martin&ZipCode=11218&SegmentKey=new-york-city

Authorization: OAuth oauth_signature="JAAAVywn3Ho2KZuuZXG9TEmt59k%3d", oauth_nonce="8094055", oauth_timestamp="1312575398", oauth_consumer_key="43c5c674-620c-4f2b-bdcf-3082c99e8186", oauth_signature_method="HMAC-SHA1", oauth_version="1.0"

Host: apitest.groupcommerce.com

Sample XML Response:
<addEmailLeadResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <errors/>
    <lastPublished>2011-08-05T20:18:49.9031696Z</lastPublished>
    <success>true</success>
    <version>2</version>
</addEmailLeadResult>


Sample JSON Response:
{
    "errors": [],
    "lastPublished": "/Date(1312575454195)/",
    "success": true,
    "version": "2"
}

Comments