Remove an email address from the Email to SMS authorised list.


We created a new viewing experience for our SMS API documentation. It's now all in one central location. Click here to check it out!


Parameter

Description

Required

emailEmail address to remove. You may also use a wild-card email which removes all emails on that domain.

Wild-card format: *@example.com
YES


Example


curl https://api.transmitsms.com/delete-email.json \
  -u 2e24c1cbdd987221e165d543f34b84bf:secret \
  -d 'email=email@client.com'


JSON Response

{
  success: true
}

XML Response

<?xmlversion="1.0"encoding="UTF-8"?>
<response>
  <success>true</success>
</response>


PHP Examples


<?php
 include '../../APIClient2.php';

 $api = new transmitsmsAPI('API_KEY', 'API_SECRET');
 $result = $api->deleteEmail('email@client.com');

 if ($result->error->code == 'SUCCESS') {
   echo 'Email deleted';

 } else {
   echo 'Error: {$result->error->description}';
 }