Menu

Lists

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

Update List

Update List

PATCH /marketing/lists/{id}

This endpoint updates the name of a list.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Request Body

object
name
string

Your name for your list.

{
  "name": "updated-list-name"
}

Path Parameters

id
string
required

Responses

object
id
string

The generated ID for your list.

maxLength: 36minLength: 36
name
string

The name you gave your list.

contact_count
integer

The number of contacts currently stored on the list.

_metadata
object
self
string

A link to this object.

object
errors
array[object]
message
string
field
string
error_id
string
parameter
string
object

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.