Navigate...
Update List
sdk.lists.update(listId, req)
Update a recipient list name or notes. Only include the fields you want to change. Set notes: null to clear existing notes.
API key required to run methods
API Key *
Base URL
listId
string
required
List ID to update
List ID
Name
Notes
Returns
RecipientList
Updated list object
id
string
List identifier
projectId
string
Project that owns the list
name
string
Updated list name
notes
string | null
Updated notes
totalItems
number
Number of recipients
createdAt
string
ISO 8601 creation timestamp
updatedAt
string
ISO 8601 last update timestamp
Errors
Invalid list id
The request is not authorized
You do not have permission to access this resource
List not found
Generated Code