Skip to content Skip to navigation Skip to topbar

Add Multiple Recipients to a List

API Overview

(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

POST/v3/contactdb/lists/{list_id}/recipients

Base url: https://api.sendgrid.com

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 should be passed exactly as they are returned from recipient endpoints.

Operation details

Authentication

API Key

Headers

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.

Path parameters

Property nameTypeRequiredDescription

list_idintegerrequired

The id of the list of recipients you want to retrieve.

Request body

SchemaExample

array[integer]

Responses

201400401404

Schema

Property nameTypeRequiredDescriptionChild properties

No properties defined

The request was formatted incorrectly or missing required parameters.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

Returned if list_id does not exist

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

Add Multiple Recipients to a List

Node.js

Python

Java

PHP

Ruby

curl


_23const client = require('@sendgrid/client');
_23client.setApiKey(process.env.SENDGRID_API_KEY);
_23
_23const list_id = 4900;
_23const data = [
_23  1,
_23  2
_23];
_23
_23const request = {
_23  url: `/v3/contactdb/lists/${list_id}/recipients`,
_23  method: 'POST',
_23  body: data
_23}
_23
_23client.request(request)
_23  .then(([response, body]) => {
_23    console.log(response.statusCode);
_23    console.log(response.body);
_23  })
_23  .catch(error => {
_23    console.error(error);
_23  });