v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

Contacts

Delete a contact from a list

post/contacts/lists/{listId}/contacts/remove

Path parameters

listIdinteger required

Id of the list

Request body

emailsstring[]

Required if 'all' is false. Emails to remove from a list. You can pass a maximum of 150 emails for removal in one request.

idsinteger[]

Mandatory if Emails are not passed, ignored otherwise. Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api.

allboolean

Required if none of 'emails' or 'ids' are passed. Remove all existing contacts from a list. A process will be created in this scenario. You can fetch the process details to know about the progress

Example request

{
  "emails": [
    "john.smith@contact.com OR 151"
  ],
  "ids": [
    121
  ]
}

Response

All contacts have been removed successfully from the list with details of failed ones

Example response

{
  "contacts": {
    "total": 27,
    "processId": 78,
    "success": [
      "jeff32@example.com, jim56@example.com",
      "jeff32@example.com, jim56@example.com"
    ],
    "failure": [
      "jeff32@example.com, jim56@example.com",
      "jeff32@example.com, jim56@example.com"
    ]
  }
}