Lists

Remove Contacts from List

Remove specified Contacts from your list. Required Access Level: ModifyContacts

post/lists/{name}/contacts/remove

Request

  • Base URL
    https://api.elasticemail.com/v4
  • URL
    https://api.elasticemail.com/v4/lists/{name}/contacts/remove
  • Auth
    API key in header X-ElasticEmail-ApiKey

Path parameters

namestring string required

string

Example:My List 1

Name of your list.

Request body

Rulestring string

SQL-like rule. Sending 'All' as a value loads all resources of the given type. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules

Emailsstring[]

Comma delimited list of contact emails

Example request

{
  "Emails": [
    "john.doe@sample.com"
  ]
}

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.