Exigo Web Services API v3.4.244

CreateCustomerLead

Creates a new customer lead.

Note: This request can participate in a transaction. Learn more about transactions.

Input Properties

CreateCustomerLeadRequest
PropertyData TypeNotes
CustomerIDInt32Unique identifier for a customer entity.
FirstNameStringOptional.
LastNameStringOptional.
MiddleNameStringOptional.
CompanyStringOptional.
PhoneStringOptional.
Phone2StringOptional.
MobilePhoneStringOptional.
FaxStringOptional.
EmailStringOptional.
Address1StringOptional.
Address2StringOptional.
CityStringOptional.
State StringOptional.
ZipStringOptional.
Country StringOptional.
BirthDateDateTimeOptional.
NotesStringOptional.

Output Properties

CreateCustomerLeadResponse
PropertyData TypeNotes
CustomerLeadIDInt32Unique identifier for a customer lead entity.

SOAP Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.exigo.com/CreateCustomerLead"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Header> <ApiAuthentication xmlns="http://api.exigo.com/"> <LoginName>string</LoginName> <Password>string</Password> <Company>string</Company> <Identity>string</Identity> <RequestTimeUtc>dateTime</RequestTimeUtc> <Signature>string</Signature> </ApiAuthentication> </soap:Header> <soap:Body> <CreateCustomerLeadRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <FirstName>string</FirstName> <LastName>string</LastName> <MiddleName>string</MiddleName> <Company>string</Company> <Phone>string</Phone> <Phone2>string</Phone2> <MobilePhone>string</MobilePhone> <Fax>string</Fax> <Email>string</Email> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <State>string</State> <Zip>string</Zip> <Country>string</Country> <BirthDate>dateTime</BirthDate> <Notes>string</Notes> </CreateCustomerLeadRequest> </soap:Body> </soap:Envelope>

SOAP Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CreateCustomerLeadResult xmlns="http://api.exigo.com/"> <CustomerLeadID>int</CustomerLeadID> </CreateCustomerLeadResult> </soap:Body> </soap:Envelope>

C#

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    CreateCustomerLeadRequest req = new CreateCustomerLeadRequest();

 

    req.CustomerID = 1;             //Unique identifier for a customer entity.

    req.FirstName = "1";

    req.LastName = "1";

    req.MiddleName = "1";

    req.Company = "1";

    req.Phone = "1";

    req.Phone2 = "1";

    req.MobilePhone = "1";

    req.Fax = "1";

    req.Email = "1";

    req.Address1 = "1";

    req.Address2 = "1";

    req.City = "1";

    req.Zip = "1";

    req.BirthDate = DateTime.Today;

    req.Notes = "1";

 

    //Send Request to Server and Get Response

    CreateCustomerLeadResponse res = api.CreateCustomerLead(req);

 

    //Now examine the results:

    Console.WriteLine("CustomerLeadID: {0}", res.CustomerLeadID);

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new CreateCustomerLeadRequest()

 

    req.CustomerID = 1

    req.FirstName = "1"

    req.LastName = "1"

    req.MiddleName = "1"

    req.Company = "1"

    req.Phone = "1"

    req.Phone2 = "1"

    req.MobilePhone = "1"

    req.Fax = "1"

    req.Email = "1"

    req.Address1 = "1"

    req.Address2 = "1"

    req.City = "1"

    req.Zip = "1"

    req.BirthDate = DateTime.Today

    req.Notes = "1"

 

    'Send Request to Server and Get Response

    Dim res As CreateCustomerLeadResponse = api.CreateCustomerLead(req)

 

    'Now examine the results:

    Console.WriteLine("CustomerLeadID: {0}", res.CustomerLeadID)

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->CustomerID = 1;

    $req->FirstName = "1";

    $req->LastName = "1";

    $req->MiddleName = "1";

    $req->Company = "1";

    $req->Phone = "1";

    $req->Phone2 = "1";

    $req->MobilePhone = "1";

    $req->Fax = "1";

    $req->Email = "1";

    $req->Address1 = "1";

    $req->Address2 = "1";

    $req->City = "1";

    $req->Zip = "1";

    $req->BirthDate = 1;

    $req->Notes = "1";

 

    //Send Request to Server and Get Response

    $res = $api.CreateCustomerLead($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    CreateCustomerLeadRequest req = new CreateCustomerLeadRequest();

 

    req.setCustomerID(1);

    req.setFirstName("1");

    req.setLastName("1");

    req.setMiddleName("1");

    req.setCompany("1");

    req.setPhone("1");

    req.setPhone2("1");

    req.setMobilePhone("1");

    req.setFax("1");

    req.setEmail("1");

    req.setAddress1("1");

    req.setAddress2("1");

    req.setCity("1");

    req.setZip("1");

    req.setBirthDate(1);

    req.setNotes("1");

 

    //Send Request to Server and Get Response

    CreateCustomerLeadResponse res = api.getExigoApiSoap().createCustomerLead(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.