deleteContact.md

Delete Contacts

This guide will walk you through steps of deleting contact(s) from your account using the Bash library.

Required Access Level: ModifyContacts

Find out more by checking our API's documentation: https://elasticemail.com/developers/api-documentation/rest-api#operation/contactsByEmailDelete

What's a contact?

When using Elastic Email, you send emails to contacts – recipients who receive your emails. Contacts can be grouped by created segments or lists.

Preparation

It's a Bash script so it's a program to be run by Unix shell. On linux (eg. Ubuntu) there's no need to install anything additional.

Create a new file eg. script.sh

Download the lib from ElasticEmail repository https://github.com/ElasticEmail/elasticemail-bash and make sure the script has executable rights

$ chmod u+x ElasticEmail

Let's dig into the code

Put the below code to your file.

In the first line indicate that it's a bash script:

#!/bin/bash

Variable for host value:

host=https://api.elasticemail.com

Use your API key (remember to check a required access level):

apiKey=YOUR_API_KEY

and create header variables for api key:

apiKeyHeaderName=X-ElasticEmail-ApiKey
apiKeyHeader=$apiKeyHeaderName:$apiKey

Define a method that will be used:

apiMethod=contactsDeletePost

Define JSON with emails to delete:

json='{ 
        Emails: ["johnsmith@domain.com2"]
    }'

And finally, you can use the lib to make an api call:

echo $json | ./ElasticEmail --host $host --content-type json $apiMethod - $apiKeyHeader

The whole code to copy and paste:

#!/bin/bash

host=https://api.elasticemail.com

apiKey=YOUR_API_KEY

apiKeyHeaderName=X-ElasticEmail-ApiKey
apiKeyHeader=$apiKeyHeaderName:$apiKey

apiMethod=contactsDeletePost

json='{ 
        Emails: ["johnsmith@domain.com2"]
    }'

echo $json | ./ElasticEmail --host $host --content-type json $apiMethod - $apiKeyHeader

Run the code

bash script.sh