# update

URL: /business/nouns/newsletter/update · Id: `verb:Newsletter.update` · Call: `await $.Newsletter.update({ … })` (SDK) or the `do` tool at `https://api.sb/mcp`. Inputs says what to pass, Outputs what returns, When it waits who approves.

> Changes the given properties of a Newsletter.

Update changes the given properties of a [Newsletter](/business/nouns/newsletter). It is inherited: every [Noun](/business/nouns/noun) has `get`, `list`, `create`, `update` and `delete`.

## Inputs
| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Newsletter. |
| `name` | `string` | No | What subscribers see it called. |
| `from` | [Mailbox](/business/nouns/mailbox) | No | The broadcast Mailbox each issue sends from. |
| `topic` | `string` | No | The topic a Contact subscribes to, recorded with their Consent. |
| `offer` | [Offer](/business/nouns/offer) | No | The Offer whose Subscription unlocks paid issues and the archive. |

## Outputs
| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `newsletter` | [Newsletter](/business/nouns/newsletter) | Yes | 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](/business/nouns/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`](/code/api/errors/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](/systems/trust-and-governance/controls/one-way-windows) | None: it runs once review passes. |
| Limit | The call [Limit](/business/nouns/limit) of the [Permission](/business/nouns/permission) it runs under. |
| Over the Limit | It waits `pending` for an [Approval](/business/nouns/approval) from the [Founder](/agents/founding/founder). Approved, it runs; refused, it ends `refused` with [`limit-exceeded`](/code/api/errors/limit-exceeded); unanswered by its deadline, it ends `canceled`. |

## Example

**Ask**

```text
Change the newsletter “Leaseline notes”.
```

**API**

```bash
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"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "newsletter": {
    "$id": "https://api.sb/leaseline.app/newsletters/newsletter_FLjN3aQujc",
    "$type": "Newsletter",
    "name": "Leaseline notes",
    "from": "mailbox_93HvOnR17L"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Newsletter.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

**SDK**

```ts
import { $ } from 'startup-builder'

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

**CLI**

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

**MCP**

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