Exigo Web Services API v2018.8.27.1

SendEmail

Sends a specified Email using SendGrid

Input Properties

SendEmailRequest
PropertyData TypeNotes
CustomerIDInt32Optional. CustomerID the email will be logged as being sent to.
MailFromStringMail Address the email will be sent from.
MailToStringMail Address the email will be sent to, will use customer email is not specified.
SubjectStringEmail Subject line.
BodyStringEmail Body.
CustomerKeyStringOptional. CustomerKey the email will be logged as being sent to.

Output Properties

SendEmailResponse
PropertyData TypeNotes

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/SendEmail"

<?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> <SendEmailRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <MailFrom>string</MailFrom> <MailTo>string</MailTo> <Subject>string</Subject> <Body>string</Body> <CustomerKey>string</CustomerKey> </SendEmailRequest> </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> <SendEmailResult xmlns="http://api.exigo.com/" /> </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

    SendEmailRequest req = new SendEmailRequest();

 

    req.CustomerID = 1;             //CustomerID the email will be logged as being sent to

    req.MailFrom = "company@test.com";//Mail Address the email will be sent from

    req.MailTo = "customer@test.com";//Mail Address the email will be sent to, will use customer email is not specified

    req.Subject = "1";              //Email Subject line

    req.Body = "1";                 //Email Body

    req.CustomerKey = "1";          //CustomerKey the email will be logged as being sent to

 

    //Send Request to Server and Get Response

    SendEmailResponse res = api.SendEmail(req);

 

    //Now examine the results:

}

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 SendEmailRequest()

 

    req.CustomerID = 1

    req.MailFrom = "company@test.com"

    req.MailTo = "customer@test.com"

    req.Subject = "1"

    req.Body = "1"

    req.CustomerKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As SendEmailResponse = api.SendEmail(req)

 

    'Now examine the results:

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->MailFrom = "company@test.com";

    $req->MailTo = "customer@test.com";

    $req->Subject = "1";

    $req->Body = "1";

    $req->CustomerKey = "1";

 

    //Send Request to Server and Get Response

    $res = $api.SendEmail($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

    SendEmailRequest req = new SendEmailRequest();

 

    req.setCustomerID(1);

    req.setMailFrom("company@test.com");

    req.setMailTo("customer@test.com");

    req.setSubject("1");

    req.setBody("1");

    req.setCustomerKey("1");

 

    //Send Request to Server and Get Response

    SendEmailResponse res = api.getExigoApiSoap().sendEmail(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.