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 the Contacts API, please visit the new Marketing Campaigns Contacts API.
The Contacts Recipients API allows you to manage your recipients. You can add, retrieve, update, and delete recipients, as well as get a count of all recipients and all billable recipients.
This endpoint allows you to update one or more recipients.
The body of an API call to this endpoint must include an array of one or more recipient objects.
It is of note that you can add custom field data as parameters on recipient objects. We have provided an example using some of the default custom fields SendGrid provides.
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.
application/jsonArray of:
Optional
The last name of the recipient. This is one of the default custom fields.
Optional
The first name of the recipient. This is one of the default custom fields.
The number of errors found while adding recipients.
0The indices of the recipient(s) sent that caused the error.
[]The count of new recipients added to the contactdb.
0The recipient IDs of the recipients that already existed from this request.
[]The recipients who were updated from this request.
01const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const data = [5{6email: "jones@example.com",7last_name: "Jones",8first_name: "Guy",9},10];1112const request = {13url: `/v3/contactdb/recipients`,14method: "PATCH",15body: data,16};1718client19.request(request)20.then(([response, body]) => {21console.log(response.statusCode);22console.log(response.body);23})24.catch((error) => {25console.error(error);26});