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
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.
This endpoint allows you to add multiple recipients to a list.
Adds existing recipients to a list, passing in the recipient IDs to add. Recipient IDs (base64-encoded email addresses) should be passed exactly as they are returned from recipient endpoints.
Bearer <<YOUR_API_KEY_HERE>>Optional
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.
The id of the list of recipients you want to retrieve.
application/jsonarray[string]No properties defined
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const list_id = 4900;5const data = ["ZW1haWwxQGV4YW1wbGUuY29t", "ZW1haWwyQHRlc3QubmV0"];67const request = {8url: `/v3/contactdb/lists/${list_id}/recipients`,9method: "POST",10body: data,11};1213client14.request(request)15.then(([response, body]) => {16console.log(response.statusCode);17console.log(response.body);18})19.catch((error) => {20console.error(error);21});