Api Documentation

How Do I Add/Remove a Contact from a List Via API

Uploading individual contact lists can take up time you can invest elsewhere. By creating a webhook you can instantly and automatically add or remove contacts from your Inbox Mailers lists.

What You'll Need

  • API Key
  • Email addresses of the contacts to add or remove

Task Steps

    1. API Endpoint
        1. Use the following API endpoint to add or remove contacts:
          https://api.inboxmailers.com/contacts
        2. To add contacts, use the POST method.
        3. To remove contacts, use the DELETE method.
    2. Header
      1. Replace the {{YOUR_API_KEY}} placeholder text with your API key. To locate your API key, open the Profile Menu and select Integrations.
        {"x-api-key": "{{YOUR_API_KEY}}"}
    3. Request Body
        1. Please note, list_ids is a unique identifier for the selected list and is a prepopulated value. The list_ids value does not need to be edited.
        2. To add or remove contacts, replace the placeholder email addresses with the email addresses of the contacts.
          { "list_ids": ["766"],
          "contacts": [
          {"email": "abc@example.com"},
          {"email": "xyz@example.com"}
          ]}