Skip to content Skip to navigation Skip to topbar

Update List

API Overview

Lists are static collections of Marketing Campaigns contacts. This API allows you to interact with the list objects themselves. To add contacts to a list, you must use the Contacts API.

You can also manage your lists using the Contacts menu in the Marketing Campaigns UI. For more information about lists and best practices for building them, see "Building your Contact List".

Operation overview

PATCH/v3/marketing/lists/{id}

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

This endpoint updates the name of a list.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

idstringrequired

The ID of the list on which you want to perform the operation.

Request body

SchemaExample

Property nameTypeRequiredDescriptionChild properties

namestringOptional

Your name for your list.

Responses

200400404

SchemaExample

Property nameTypeRequiredDescriptionChild properties

idstring

The generated ID for your list.

Min length: 36Max length: 36

namestring

The name you gave your list.

contact_countinteger

The number of contacts currently stored on the list.

_metadataobject

Show child properties for _metadata

Update List

Node.js

Python

Java

PHP

Ruby

curl


_22const client = require('@sendgrid/client');
_22client.setApiKey(process.env.SENDGRID_API_KEY);
_22
_22const id = "ZGkrHSypTsudrGkmdpJJ";
_22const data = {
_22  "name": "updated-list-name"
_22};
_22
_22const request = {
_22  url: `/v3/marketing/lists/${id}`,
_22  method: 'PATCH',
_22  body: data
_22}
_22
_22client.request(request)
_22  .then(([response, body]) => {
_22    console.log(response.statusCode);
_22    console.log(response.body);
_22  })
_22  .catch(error => {
_22    console.error(error);
_22  });