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

Update Recipient



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


PATCH/v3/contactdb/recipients

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

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.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstring

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.

SchemaExample

Array of:

emailstring<email>required

last_namestring

The last name of the recipient. This is one of the default custom fields.


first_namestring

The first name of the recipient. This is one of the default custom fields.

201400401
SchemaExample
error_countnumber

The number of errors found while adding recipients.

Default: 0

error_indicesarray[number]

The indices of the recipient(s) sent that caused the error.

Default: []

new_countnumber

The count of new recipients added to the contactdb.

Default: 0

persisted_recipientsarray[string]

The recipient IDs of the recipients that already existed from this request.

Default: []

updated_countnumber

The recipients who were updated from this request.

Default: 0

errorsarray[object]

Update Recipient

update-recipient page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_25
const client = require('@sendgrid/client');
_25
client.setApiKey(process.env.SENDGRID_API_KEY);
_25
_25
const data = [
_25
{
_25
"email": "jones@example.com",
_25
"last_name": "Jones",
_25
"first_name": "Guy"
_25
}
_25
];
_25
_25
const request = {
_25
url: `/v3/contactdb/recipients`,
_25
method: 'PATCH',
_25
body: data
_25
}
_25
_25
client.request(request)
_25
.then(([response, body]) => {
_25
console.log(response.statusCode);
_25
console.log(response.body);
_25
})
_25
.catch(error => {
_25
console.error(error);
_25
});


Rate this page: