Navigate...

K

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 *

Don't have an API key?Get one at dashboard.multisender.app

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

400

Invalid list id

401

The request is not authorized

403

You do not have permission to access this resource

404

List not found

See Also

delete()

Delete the list entirely

Previous

create()

Next

delete()

Generated Code