Contact Lists API — Create, Search, and Delete Lists

Authentication

All endpoints accept either an ApiKey header or an OAuth header. See the OAuth Endpoints page for token generation.

Add List

Creates a new contact list with an optional description.

Request Body

string

required

Unique name for the new contact list.

string

A short description of the list’s purpose or audience.

boolean

When true, the operation is simulated and no list is created.

Response

integer

200 on success.

string

Empty string on success; an error description on failure.

curl --request POST \
  --url https://api.effilink.co/v5/lists/add \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "listName": "VIP Customers",
    "listDescription": "High-value customer segment"
  }'

Response

{
  "code": 200,
  "message": ""
}

Get Lists

Returns a paginated, optionally filtered collection of contact lists belonging to your account.

Request Body

string

Filter lists by name. Returns all lists that contain this string.

string

Filter by list type:

"0" — Dynamic lists (rule-based membership).
"1" — Static lists (manually managed membership).

string

Sort field for results. Accepted values:

"CreateDate" — Sort by creation date.
"ModifyDate" — Sort by last modification date.

integer

Number of lists to return per page. Defaults to 10.

integer

One-based page number. Defaults to 1.

Response

integer

200 on success.

string

Empty string on success; an error description on failure.

array[object]

Array of list records matching the query.

Show list object

string

Unique identifier for the list.

string

Identifier of the team that owns the list.

string

Human-readable name of the list.

integer

Current status of the list (e.g. 1 = active).

integer

0 for dynamic lists; 1 for static lists.

string

Filter conditions for dynamic lists. Present on dynamic lists (ListType: 0); empty or absent for static lists.

integer

ID of the user who created the list.

string

ISO 8601 timestamp of when the list was created.

string

ISO 8601 timestamp of the most recent update to the list.

integer

Total number of lists matching the query across all pages.

curl --request POST \
  --url https://api.effilink.co/v5/lists/get \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "search": "VIP",
    "pageSize": 20,
    "pageIndex": 1
  }'

Response

{
  "code": 200,
  "message": "",
  "lists": [
    {
      "Id": "abc123",
      "TeamId": "team001",
      "listName": "VIP Customers",
      "ListStatus": 1,
      "ListType": 1,
      "CreateUserId": 42,
      "CreateDate": "2024-01-15T08:00:00.000Z",
      "ModifyDate": "2025-03-10T14:30:00.000Z"
    }
  ],
  "totalRecords": 1
}

Delete List

Permanently deletes a contact list by name. Contacts within the list are not deleted — only the list itself is removed.

Request Body

string

required

Name of the contact list to delete.

boolean

When true, the operation is simulated and no list is deleted.

Response

integer

200 on success.

string

Empty string on success; an error description on failure.

Response

{
  "code": 200,
  "message": ""
}

Transactional Email

Campaign Email

SMS

Contacts & Lists

Webhooks

Authentication

Contact Lists API — Create, Search, and Delete Lists

Authentication

Add List

Request Body

Response

Get Lists

Request Body

Response

Delete List

Request Body

Response

​Authentication

​Add List

​Request Body

​Response

​Get Lists

​Request Body

​Response

​Delete List

​Request Body

​Response

Authentication

Add List

Request Body

Response

Get Lists

Request Body

Response

Delete List

Request Body

Response