Exigo Web Services API v2022.12.19.1

 Search

OptOutEmail

Opts out all customers and customer contacts with specified email from receiving broadcast emails.

Input Properties

OptOutEmailRequest
PropertyData TypeNotes
EmailStringOptional. The address you are opting out.

Output Properties

OptOutEmailResponse
PropertyData TypeNotes
RecordsAffectedInt32

Http Request

POST https://yourcompany-api.exigo.com/3.0/email/optout HTTP/1.1
Content-Type: application/json
Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword)


{
  "email": "johndoe@email.com"
}

Http Response

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


{
  "recordsAffected": 1,
  "result": null
}

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: totallife-api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/OptOutEmail"

<?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>
    <OptOutEmailRequest xmlns="http://api.exigo.com/">
      <Email>string</Email>
    </OptOutEmailRequest>
  </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>
    <OptOutEmailResult xmlns="http://api.exigo.com/">
      <RecordsAffected>int</RecordsAffected>
    </OptOutEmailResult>
  </soap:Body>
</soap:Envelope>

C# Rest Client

Install Nuget package Exigo.Api.Client

try

{

    //Create Api Client

    var api = new ExigoApiClient("yourcmpany", "yourlogin", "yourpassword");

 

    //Create Request

    var req = new OptOutEmailRequest();

 

    req.Email = "johndoe@email.com";//The address you are opting out.

 

    //Send Request to Server and Get Response

    var res = await api.OptOutEmailAsync(req);

 

    //Now examine the results:

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

}

catch (Exception ex)

{

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

}

C# Soap Client

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

    OptOutEmailRequest req = new OptOutEmailRequest();

 

    req.Email = "johndoe@email.com";//The address you are opting out.

 

    //Send Request to Server and Get Response

    OptOutEmailResponse res = api.OptOutEmail(req);

 

    //Now examine the results:

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

}

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

 

    req.Email = "johndoe@email.com"

 

    'Send Request to Server and Get Response

    Dim res As OptOutEmailResponse = api.OptOutEmail(req)

 

    'Now examine the results:

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

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->Email = "johndoe@email.com";

 

    //Send Request to Server and Get Response

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

    OptOutEmailRequest req = new OptOutEmailRequest();

 

    req.setEmail("johndoe@email.com");

 

    //Send Request to Server and Get Response

    OptOutEmailResponse res = api.getExigoApiSoap().optOutEmail(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.