Skip to main content
PATCH
/
audience
/
lists
/
{listId}
Update an audience list
curl --request PATCH \
  --url https://app.lettr.com/api/audience/lists/{listId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Newsletter subscribers (renamed)"
}
'
{
  "message": "List retrieved successfully.",
  "data": {
    "id": "0193e6a8-1f3a-7c2a-b9e2-1aa1d2e5d3f0",
    "name": "Newsletter subscribers",
    "contacts_count": 124
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.lettr.com/llms.txt

Use this file to discover all available pages before exploring further.

Partially update an audience list. If no fields are provided the existing list is returned unchanged. Requires the audience:write scope and is blocked for sandbox API keys.

Authorizations

​
Authorization
string
header
required

API key for authentication

Path Parameters

​
listId
string<uuid>
required

List ID

Body

application/json

Request to update an audience list. All fields are optional.

​
name
string

New list name (must remain unique within the team)

Maximum string length: 255
Example:

"Newsletter subscribers (renamed)"

Response

Updated

​
message
string
required
Example:

"List retrieved successfully."

​
data
object
required

Audience list summary