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

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 the suppression list via API on Herbmail 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 Herbmail 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.herb.report/suppression" \
       -H 'x-api-key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
       -H "Content-Type: application/json" \ 
       -d '{"clientId" : "XXXXXXXX", "email": "testsuppression@gmail.com"}'

• API endpoint
  

  https://api.Herbmail.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:

1. Login to your Zapier account and click on the “Create Zap” button from the left bar on the dashboard.
   
2. From the top left click on the edit icon to add the name of Zap  “Herbmail Suppression List”.
   
3. 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.
   
   
4. Under event select  "New Spreadsheet Row", and click "Continue"
   
   
5. Under the account option please authenticate the Google Sheet account to integrate, and click "Continue"
   
   
6. Under Trigger select the relevant Spreadsheet, Worksheet and trigger column, you plan to use to upload to the suppression list, and click "Continue"

7. Under Test, Click "Test trigger"
   
   
8. 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"
   
9. In the next step, under the action search bar, search for "Webhooks by Zapier" and select that
   
10. Under Event, select "Custom Request" and, Click "Continue"
    
11. Under Action, make the following changes:
    • Select "Post" under Method dropdown
    • URL: https://api.Herbmail.com/suppression
    • Select "False" under Data Pass-Through dropdown
    • Data: {"clientId" :"[Your PublicID provided by Herbmail]", "email": "[choose email field from Trigger]"}
    • Headers: "x-api-key"  with value [API key provided by Herbmail]
      
12. Click Continue
13. Click "Test Step"
    
    Note: You can verify if the Zap is working as expected by visiting the Suppression list tab on the Herbmail Dashboard and seeing the test email added there.
    
14. Under Test, Click "Publish"