How do I update the suppression list via API on Opensend?

Keep your suppression list up-to-date automatically and in real-time via our API. Integrate either directly, or via Zapier (see below).

Prerequisites:

To update suppression list via API on Opensend you will need:

API-KEY: Please follow this guide to get your API-KEY
PUBLICID: Please follow this guide to get your PUBLICID

Once you have these, emails can be added to your Opensend suppression list by sending a POST request to to our endpoint, containing API-KEY, PUBLICID, and email address.

Guide on direct API Integration:

Sample

curl -i -X POST "https://api.opensend.com/suppression" \
     -H 'x-api-key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
     -H "Content-Type: application/json" \  
     -d '{"clientId" : "XXXXXXXX", "email": "testsuppression@gmail.com"}'

API endpoint
```
https://api.opensend.com/suppression
```

Header

x-api-key: API-KEY
Content-Type: application/json

Input

{"clientId" :"PUBLICID", "email": "test@domain.com"}

Result
```
{"status": "Success."}
```

Guide on using Suppression List API Integration with Zapier:

Login to your Zapier account and click on the “Create Zap” button from the left bar on the dashboard.
From the top left click on the edit icon to add the name of Zap “Opensend Suppression List”.
Click on "Trigger". Then under the trigger search bar, search for the Email marketing platform or another tool you want to use as the source of the suppression list e.g. "Google Sheets"
Note: Using Google sheet as a trigger is just an example and in your case, you can use the trigger of your choice, it should be the platform where you have your contacts to be uploaded to the suppression list.
Under event select "New Spreadsheet Row", and click "Continue"
Under the account option please authenticate the Google Sheet account to integrate, and click "Continue"
Under Trigger select the relevant Spreadsheet and Worksheet, you plan to use to upload to the suppression list, and click "Continue"
Under Test, Click "Test trigger"
Select a record from the sheet that will be used for mapping out the fields in the next steps and Click "Continue with selected record"
In the next step, under the action search bar, search for "Webhooks by Zapier" and select that
Under Event, select "Custom Request" and, Click "Continue"
Under Action, make the following changes:
1. Select "Post" under Method dropdown
2. URL: https://api.opensend.com/suppression
3. Select "False" under Data Pass-Through dropdown
4. Data: {"clientId" :"[Your PublicID provided by Opensend]", "email": "[choose email field from Trigger]"}
5. Headers: "x-api-key" with value [API key provided by Opensend]
Click Continue
Click "Test Step"

Note: You can verify if the Zap is working as expected by visiting the Suppression list tab on the Opensend Dashboard and seeing the test email added there.
Under Test, Click "Publish"