Skip to content

Newsletter programs: update, delete

The Newsletter Verbs update, delete as MCP do programs, with inputs, result, refusals and an example.

Reference for Newsletter, one group of Newsletter programs.

Newsletter.update

Changes the given properties of a Newsletter. Verb page.

Text
do: return await $.Newsletter.update(input)

Emits Newsletter.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Newsletter.
namestringWhat subscribers see it called.
fromMailboxThe broadcast Mailbox each issue sends from.
topicstringThe topic a Contact subscribes to, recorded with their Consent.
offerOfferThe Offer whose Subscription unlocks paid issues and the archive.

Returns

OutputTypeRequiredDescription
newsletterNewsletterrequiredThe Newsletter.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

JSON
{
  "name": "do",
  "arguments": {
    "code": "return await $.Newsletter.update({ id: 'newsletter_FLjN3aQujc', name: 'Leaseline notes' })"
  }
}

Newsletter.delete

Deletes a Newsletter: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
do: return await $.Newsletter.delete(input)

Emits Newsletter.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Newsletter.

Returns

OutputTypeRequiredDescription
newsletterNewsletterrequiredThe Newsletter.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

JSON
{
  "name": "do",
  "arguments": {
    "code": "return await $.Newsletter.delete({ id: 'newsletter_FLjN3aQujc' })"
  }
}