smartchat

list_newsletters

Lists the newsletters of the account, newest first. Use it to find a newsletter ID and its state. Returns newsletters with status, audience, template state and whether they are ready to send.

Tool namelist_newsletters
Permissionnewsletters:read
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
openWorldHintfalse
REST callGET /v1/newsletters

#What it does

  • Only reads data. It changes nothing and sends nothing.

#Input

The tool takes one flat object. Path, query and body fields of the REST call are merged into it.

NameTypeRequiredDescription
limitintegernoItems per page (1 to 100, default 20). 1 to 100; default 20
cursorstringnonext_cursor from the previous page. Opaque; only valid with the same filters. up to 300 characters
statusstringnoOnly newsletters in this state. one of: draft, scheduled, sending, paused, completed, canceled, failed

Arguments added by the MCP server (see Special arguments)

NameTypeRequiredDescription
detailstringnoconcise (default): key fields per item. full: every field. one of: concise, full; default "concise"

#Result

The result has the same content as the REST answer. Lists have at most 50 items per page (default 20); use cursor for the next page.

Errors come back as a tool result with isError: true. The error codes are the ones in Errors.