Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
On this page

Create a List

API Overview

api-overview page anchor
(warning)

Legacy Marketing Campaigns

You are viewing the Legacy Marketing Campaigns API reference. For guidance migrating to the current version of Marketing Campaigns, see Migrating from Legacy Marketing Campaigns

(information)

Info

For the most up-to-date information on SendGrid's Contact Lists API, please visit the new Marketing Campaigns Lists API.

The Lists API allows you to manage your Marketing Campaigns contact lists. You can create, retrieve, update, and delete lists, as well as add and remove contacts from lists.

Operation overview

operation-overview page anchor

POST/v3/contactdb/lists

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

This endpoint allows you to create a list for your recipients.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
on-behalf-ofstringOptional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Request body

request-body page anchor
Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
namestringrequired

Responses

responses page anchor
201400401
SchemaExample
Property nameTypeRequiredDescriptionChild properties
idinteger

The reference ID of your list.

namestring

The name of your list. Must be unique against all other list and segment names.

recipient_countinteger

The count of recipients currently in the list.

Create a ListLink to code sample: Create a List
1
const client = require('@sendgrid/client');

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const data = {

5
  "name": "your list name"

6
};

7


8
const request = {

9
  url: `/v3/contactdb/lists`,

10
  method: 'POST',

11
  body: data

12
}

13


14
client.request(request)

15
  .then(([response, body]) => {

16
    console.log(response.statusCode);

17
    console.log(response.body);

18
  })

19
  .catch(error => {

20
    console.error(error);

21
  });