Add Suppressed Contacts

POST 
/v1/suppression/add

Add contacts to your suppression list. Each contact must have at least one identifier (email, phone number, or LinkedIn URL).

Request Body

Field	Type	Description	Required
contacts	array	Array of contact objects to suppress	✅ Yes

Contact Object Fields

Field	Type	Description	Required
email	string	Email address to suppress	❌ No
phone_number	string	Phone number to suppress	❌ No
linkedin_url	string	LinkedIn URL to suppress	❌ No

Note: At least one identifier (email, phone_number, or linkedin_url) must be provided per contact.

---

Example Request (JSON)

{
  "contacts": [
    {
      "email": "donotcontact@example.com"
    },
    {
      "linkedin_url": "https://linkedin.com/in/suppressed-user"
    },
    {
      "email": "another@example.com",
      "phone_number": "+1234567890"
    }
  ]
}

---

Response

The response returns the number of contacts successfully added and any errors encountered.

Example Success Response

{
  "added_count": 3,
  "errors": []
}

---

Error Handling

The API returns appropriate error messages with status codes if something goes wrong.

Error Code	Message	Description
400	Invalid Request	Verify your request is properly formatted
401	Unauthorized	Verify you are using a valid API key
500	Internal Server Error	An unexpected error occurred.

Example Error Response

{
  "error": {
    "code": 400,
    "message": "At least one identifier must be provided"
  }
}

Request

Responses

200

Successful response