Skip to content Skip to navigation Skip to topbar

Update 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

PATCH/v3/contactdb/lists/{list_id}

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

This endpoint allows you to update the name of one of your recipient lists.

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_idstringrequired

Query string

Property nameTypeRequiredDescription

list_idintegerrequired

The ID of the list you are updating.

Request body

SchemaExample

Property nameTypeRequiredDescriptionChild properties

namestringrequired

The new name for your list.

Responses

200400404

SchemaExample

Property nameTypeRequiredDescriptionChild properties

idinteger

The ID of the list

namestring

The new name for the list

recipient_countinteger

The number of recipients on the list

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.

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.

Update a List

Node.js

Python

Java

PHP

Ruby

curl


_26const client = require('@sendgrid/client');
_26client.setApiKey(process.env.SENDGRID_API_KEY);
_26
_26const list_id = "ZGkrHSypTsudrGkmdpJJ";
_26const queryParams = {
_26  "list_id": 4900
_26};
_26const data = {
_26  "name": "newlistname"
_26};
_26
_26const request = {
_26  url: `/v3/contactdb/lists/${list_id}`,
_26  method: 'PATCH',
_26  qs: queryParams,
_26  body: data
_26}
_26
_26client.request(request)
_26  .then(([response, body]) => {
_26    console.log(response.statusCode);
_26    console.log(response.body);
_26  })
_26  .catch(error => {
_26    console.error(error);
_26  });