Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-1410794124.7 KB
Lists

Add Contacts to List

Add existing Contacts to specified list. Required Access Level: ModifyContacts

post/lists/{name}/contacts

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

ListNamestring string

Name of your list.

PublicListIDstring guid nullable

ID code of list. Please note that this is different from the listid field.

DateAddedstring date-time

Date of creation in YYYY-MM-DDThh:ii:ss format

AllowUnsubscribeboolean

True: Allow unsubscribing from this list. Otherwise, false

Example response

{
  "ListName": "My List 1",
  "PublicListID": "E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F",
  "DateAdded": "2001-01-01T12:00:00"
}