Email_Opt_Out_Create
This API accepts a list of emails to be place in an Opt Out list. Emails in the Opt Out list will be excluded from emails being sent due to the triggering of the Data_Threshold_Reached and Sponsored_Data_Threshold_Reached email templates.
Input Fields
| Field | Type | Notes | Required? |
|---|---|---|---|
| Emails | List of Strings | Must be string representing a valid Email address. | Required |
Output Fields
NA
Example Requests
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<EmailOptOut_Create xmlns="http://api.myh2o.com/v20">
<Request>
<Credentials>
<Username>[Rev.io user]</Username>
<Password>[Rev.io password]</Password>
<Client>[Rev.io Client Code]</Client>
</Credentials>
<Emails>
<Email>[email protected]</Email>
</Emails>
</Request>
</EmailOptOut_Create>
</soap:Body>
</soap:Envelope>
Example Responses
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<EmailOptOut_CreateResponse xmlns="http://api.myh2o.com/v20">
<EmailOptOut_CreateResult>
<Header>
<Success>true</Success>
<SessionKey>ASDJHDHJASdkj2h&(*&@!___</SessionKey>
<Impersonated>false</Impersonated>
</Header>
</EmailOptOut_CreateResult>
</EmailOptOut_CreateResponse>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<EmailOptOut_CreateResponse xmlns="http://api.myh2o.com/v20">
<EmailOptOut_CreateResult>
<Header>
<Success>false</Success>
<Message>' ' is an invalid email.</Message>
<Impersonated xsi:nil="true" />
<Error_Code>S2010</Error_Code>
<Error_Description>Invalid input received.</Error_Description>
</Header>
</EmailOptOut_CreateResult>
</EmailOptOut_CreateResponse>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<EmailOptOut_CreateResponse xmlns="http://api.myh2o.com/v20">
<EmailOptOut_CreateResult>
<Header>
<Success>false</Success>
<Message>' , darren@rev' are invalid emails.</Message>
<Impersonated xsi:nil="true" />
<Error_Code>S2010</Error_Code>
<Error_Description>Invalid input received.</Error_Description>
</Header>
</EmailOptOut_CreateResult>
</EmailOptOut_CreateResponse>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<EmailOptOut_CreateResponse xmlns="http://api.myh2o.com/v20">
<EmailOptOut_CreateResult>
<Header>
<Success>false</Success>
<Message>'[email protected]' is already in the opt-out list.</Message>
<Impersonated xsi:nil="true" />
<Error_Code>S2010</Error_Code>
<Error_Description>Invalid input received.</Error_Description>
</Header>
</EmailOptOut_CreateResult>
</EmailOptOut_CreateResponse>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<EmailOptOut_CreateResponse xmlns="http://api.myh2o.com/v20">
<EmailOptOut_CreateResult>
<Header>
<Success>false</Success>
<Message>'[email protected], [email protected]' are already in the opt-out list.</Message>
<Impersonated xsi:nil="true" />
<Error_Code>S2010</Error_Code>
<Error_Description>Invalid input received.</Error_Description>
</Header>
</EmailOptOut_CreateResult>
</EmailOptOut_CreateResponse>
</soap:Body>
</soap:Envelope>
Email_Opt_Out_Delete
This API accepts a list of emails to be removed from an Opt Out list. This will remove the email from the exclusion list when emails being sent due to the triggering of the Data_Threshold_Reached and Sponsored_Data_Threshold_Reached email templates
Input Fields
| Field | Type | Notes | Required? |
|---|---|---|---|
| Emails | List of Strings | Must be string representing a valid Email address. | Required |
Output Fields
NA
Example Requests
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<EmailOptOut_Delete xmlns="http://api.myh2o.com/v20">
<Request>
<Credentials>
<Username>[Rev.io user]</Username>
<Password>[Rev.io password]</Password>
<Client>[Rev.io Client Code]</Client>
</Credentials>
<Emails>
<Email>[email protected]</Email>
</Emails>
</Request>
</EmailOptOut_Delete>
</soap:Body>
</soap:Envelope>
Example Responses
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<EmailOptOut_DeleteResponse xmlns="http://api.myh2o.com/v20">
<EmailOptOut_DeleteResult>
<Header>
<Success>true</Success>
<SessionKey>ASDJHDHJASdkj2h&(*&@!___</SessionKey>
<Impersonated>false</Impersonated>
</Header>
</EmailOptOut_DeleteResult>
</EmailOptOut_DeleteResponse>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<EmailOptOut_DeleteResponse xmlns="http://api.myh2o.com/v20">
<EmailOptOut_DeleteResult>
<Header>
<Success>false</Success>
<Message>' ' is an invalid email.</Message>
<Impersonated xsi:nil="true" />
<Error_Code>S2010</Error_Code>
<Error_Description>Invalid input received.</Error_Description>
</Header>
</EmailOptOut_DeleteResult>
</EmailOptOut_DeleteResponse>
</soap:Body>
</soap:Envelope>
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<EmailOptOut_DeleteResponse xmlns="http://api.myh2o.com/v20">
<EmailOptOut_DeleteResult>
<Header>
<Success>false</Success>
<Message>' , a' are invalid emails.</Message>
<Impersonated xsi:nil="true" />
<Error_Code>S2010</Error_Code>
<Error_Description>Invalid input received.</Error_Description>
</Header>
</EmailOptOut_DeleteResult>
</EmailOptOut_DeleteResponse>
</soap:Body>
</soap:Envelope>
Updated over 5 years ago
