smartchat

control_newsletter

Cancels a scheduled newsletter, pauses a running one or resumes a paused or failed one. Messages already delivered stay delivered, and resuming reaches only contacts who did not get it yet.

Tool namecontrol_newsletter
Permissionnewsletters:send
readOnlyHintfalse
destructiveHintfalse
idempotentHinttrue
openWorldHinttrue
REST callPOST /v1/newsletters/{newsletter_id}/control

#What it does

  • Sends WhatsApp messages to contacts.
  • Safe to repeat with the same idempotency_key.

#Input

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

NameTypeRequiredDescription
newsletter_idstringyesID of the newsletter, from list_newsletters.
actionstringyescancel = a scheduled newsletter goes back to draft. pause = stop a running send. resume = continue a paused or failed send. one of: cancel, pause, resume

Arguments added by the MCP server (see Special arguments)

NameTypeRequiredDescription
idempotency_keystringyesRequired. Unique key for this action, for example a UUID. Same key and arguments within 24 hours: first result, nothing done again. up to 255 characters

#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.