Contacts API - Lists
Elements that can be shared among more than one endpoint definition.
Update a List
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.
Authentication
- API Key
Headers
Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.
Request Body
object
name
string
The new name for your list.
required
{
"name": "newlistname"
}Path Parameters
list_id
string
default: None
required
Query String
list_id
integer
The ID of the list you are updating.
default: Nonerequired
Responses
object
id
integer
The ID of the list
name
string
The new name for the list
recipient_count
integer
The number of recipients on the list
object
errors
array[object]
message
string
the error message
field
string or null
the field that generated the error
help
object
helper text or docs for troubleshooting
id
string
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}object
errors
array[object]
message
string
the error message
field
string or null
the field that generated the error
help
object
helper text or docs for troubleshooting
id
string
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}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.