Call us toll-free @ 888-497-7898

API Call Information

area: leads

action: addlead

API Arguments

Argument Data Type Required Description
company string No company name
jobtitle string No job title
email string No email address
firstname string No First Name
lastname string No Last Name
phone string No phone number
address string No address of lead
city string No city of the field
region string No stores the state/region
zip string No stores the zipcode/postal code
country string No stores country two characters
altemail string No stores the alternate email address
altphone string No stores the alternate phone
label integer No label id
note string No stores notes on the lead
websiteurl string No Full url of the website or page lead came from
notify boolean either 1 or 0 No Notifies the person of a new lead based on their lead settings

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=leads&action=addlead&firstname=John&lastname=Smith&email=test@test.com

API Response

XML Response

<response>
<leadid>1</leadid>
<success>Lead Added</success></response>

JSON Response

{
    "leadid": "1",
    "success": "Lead Added"
}