Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Add a Single Recipient to 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.


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

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

This endpoint allows you to add a single recipient to a list.


Authentication

authentication 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.

Property nameTypeRequiredDescription
list_idintegerrequired

The ID of the list that you want to add the recipient to.


recipient_idstringrequired

The ID of the recipient you are adding to the list.

201400401404
Schema
Property nameTypeRequiredDescriptionChild properties

No properties defined

Add a Single Recipient to a List

add-a-single-recipient-to-a-list page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_20
const client = require('@sendgrid/client');
_20
client.setApiKey(process.env.SENDGRID_API_KEY);
_20
_20
const list_id = 4900;
_20
const recipient_id = "ZGkrHSypTsudrGkmdpJJ";
_20
_20
const request = {
_20
url: `/v3/contactdb/lists/${list_id}/recipients/${recipient_id}`,
_20
method: 'POST',
_20
_20
}
_20
_20
client.request(request)
_20
.then(([response, body]) => {
_20
console.log(response.statusCode);
_20
console.log(response.body);
_20
})
_20
.catch(error => {
_20
console.error(error);
_20
});


Rate this page: