Skip to content

by startups.studio

by Startups.Studio

Growth Newsletter

Newsletter.update

PATCH /{namespace}/newsletters/{id}

Changes the given properties of a Newsletter.

Noun: Newsletter
Mode: do
Event: Newsletter.updated

You, to your agent

Change the newsletter “Leaseline notes”.

curl -X PATCH https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline notes"}'

import { $ } from 'startup-builder'

const newsletter = await $.Newsletter.update({ id: 'newsletter_FLjN3aQujc', name: 'Leaseline notes' })

npx startup-builder do Newsletter.update --json '{"id":"newsletter_FLjN3aQujc","name":"Leaseline notes"}'

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

Update changes the given properties of a Newsletter. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Newsletter.
`name`	`string`		What subscribers see it called.
`from`	Mailbox		The broadcast Mailbox each issue sends from.
`topic`	`string`		The topic a Contact subscribes to, recorded with their Consent.
`offer`	Offer		The Offer whose Subscription unlocks paid issues and the archive.

Outputs

Output	Type	Required	Description
`newsletter`	Newsletter	required	The Newsletter.

Effects

Fact	Value
Action class	None: it runs within its seat's Limits
Door	Two-way: it runs at once
Modes	`try` previews it and stores nothing; `send` returns a pending Action; `do` (default) waits for the result
Idempotent	With a key: a repeat with the same `Idempotency-Key` returns the first Action, and a repeat without one runs again
Undo	Action.undo reverses it
Emits	`Newsletter.updated`

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Newsletter.send

Previous

Partner

Next