Contact Lists

Organize contacts into lists

Manage contact lists

Get all Contact Lists

get

Get all contact lists existing in your account

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

Responses

200

OK.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

get

/api/accounts/{account_id}/contacts/lists

Node.jsPHPPythonRubyC#Java

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
const lists = await client.contacts.lists.getAll();
lists.forEach(list => console.log(`${list.id}: ${list.name}`));

[
  {
    "id": 26730,
    "name": "Customers"
  },
  {
    "id": 26731,
    "name": "Old Contacts"
  }
]

Create Contact List

post

Create new Contact Lists

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

Body

application/json

namestringOptional

Responses

200

Contact List Created.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

post

/api/accounts/{account_id}/contacts/lists

Node.jsPHPPythonRubyC#Java

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
const list = await client.contacts.lists.create({ name: "Customers" });
console.log(`Created list: ${list.id}`);

{
  "id": 26730,
  "name": "Customers"
}

Get Contact List

get

Get a contact list by ID

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

list_idinteger · int64 · min: 1Required

Unique list ID

Example: 3229

Responses

200

Returns attributes of the contact list.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Resource not found

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

get

/api/accounts/{account_id}/contacts/lists/{list_id}

Node.jsPHPPythonRubyC#Java

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
const list = await client.contacts.lists.get(listId);
console.log(`List: ${list.name}`);

{
  "id": 26730,
  "name": "My Contact List"
}

Delete Contact List

delete

Delete existing Contact List

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

list_idinteger · int64 · min: 1Required

Unique list ID

Example: 3229

Responses

204

Contact List successfully deleted

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Resource not found

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

delete

/api/accounts/{account_id}/contacts/lists/{list_id}

Node.jsPHPPythonRubyC#Java

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
await client.contacts.lists.delete(listId);

No content

Update Contact List

patch

Update existing Contact List

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

list_idinteger · int64 · min: 1Required

Unique list ID

Example: 3229

Body

application/json

namestring · max: 255Optional

Responses

200

OK.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Resource not found

application/json

429

Rate limit exceeded for the current account.

application/json

500

Internal error. Retry later or contact support.

application/json

patch

/api/accounts/{account_id}/contacts/lists/{list_id}

Node.jsPHPPythonRubyC#Java

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: YOUR_ACCOUNT_ID });
const list = await client.contacts.lists.update(listId, { name: "Former Customers" });

{
  "id": 26730,
  "name": "Former Customers"
}