URL: /code/apps/ads/update-ad · Id: `page:/code/apps/ads/update-ad`

# Ad.update

> Changes an Ad’s copy, creative or status; a changed Ad goes back through the Venue’s review.

PATCH https://api.sb/{your-domain}/ads/{id}

[Changes](https://startupbuilder.dev/business/nouns/change) an [Ad](https://startupbuilder.dev/business/nouns/ad)’s copy, creative or status; a changed Ad goes back through the Venue’s review.

- **Action class:** None
- **Approval:** Runs on its own
- **Emits:** `Ad.updated`
- **Price:** Free

```text title="Run it · Ask"
Swap the losing LinkedIn ad to the carousel creative.
```

```ts title="Run it · SDK"
import { $ } from 'startup-builder'

const result = await $.try.Ad.update({ id: 'ad_Ln2kT6cR9p', format: 'carousel' })
```

```json title="Run it · Response"
{
  "api": "https://api.sb/leaseline.app",
  "ad": {
    "$id": "https://api.sb/leaseline.app/ads/ad_Ln2kT6cR9p",
    "$type": "Ad",
    "format": "carousel",
    "state": "in-review"
  },
  "action": {
    "operation": "Ad.update",
    "mode": "try",
    "status": "done"
  }
}
```

It extends the hub’s record call [`Ad.update`](https://startupbuilder.dev/business/nouns/ad/update), which every [Ad](https://startupbuilder.dev/business/nouns/ad) takes. It is one of the [Verbs](https://startupbuilder.dev/business/nouns/verb) of [Ads](/code/apps/ads#verbs).

## Inputs
| Name | Type | Meaning |
| --- | --- | --- |
| `id` | `string` | Required. The id of the Ad. |
| `format` | `string` | One of `search`, `display`, `image`, or `video`. Optional. |
| `spend` | `money` | What it has cost so far. Optional. |

The hub inherits this call on every Noun: it takes the Ad’s own Properties, listed on [the hub’s Ad page](https://startupbuilder.dev/business/nouns/ad).

## Outputs
| Field | Type | What `null` means |
| --- | --- | --- |
| `ad` | `Ad` | Never null: the Ad as the call leaves it. |

## Effects
**Action class**

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

**Modes**

- `try`: Runs every check and returns the record as it would be; nothing is stored.
- `send`: Returns a pending Action at once; `Ad.updated` fires when it is done.
- `do`: Waits for the Action to finish and returns the record.

**Idempotency**

Only with a key: the same `Idempotency-Key` and input return the first Action, and the same key with other input returns `409`.

**Saved or shared**

The Ad is saved as the call leaves it, with the Action that changed it.

**Emits**

`Ad.updated` with `{ ad }`

**Performed by**

Whichever seat calls it

**Price**

Free on your own account: the platform charges nothing for the call.

## On each Venue
It acts on your own records and reaches no Venue, so every account answers the same way.

## What try does
Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

## Refuses when
The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

## When it waits
Returns in one response; nothing waits.

## Example
In `send` mode the call returns its pending Action at once, and `Ad.updated` delivers the result.

**Ask**

```text
Swap the losing LinkedIn ad to the carousel creative.
```

**API**

```bash
curl -X PATCH "https://api.sb/leaseline.app/ads/ad_Ln2kT6cR9p?mode=send" \
  -H "Authorization: Bearer $SB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "format": "carousel"
}'
```

**CLI**

```bash
npx startup-builder do Ad.update --send --data '{
  "format": "carousel"
}'
```

`--send` returns the pending Action at once.

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "mode": "send",
    "code": "return await $.Ad.update({ format: 'carousel' })"
  }
}
```

**SDK**

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

const result = await $.send.Ad.update({
  id: 'ad_Ln2kT6cR9p',
  format: 'carousel',
})
```


```json title="Response, in send mode"
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Ad.update",
    "status": "pending",
    "reason": "running"
  }
}
```

To retry, send the same `Idempotency-Key`: the retry returns the first answer for $0. A new key reads again.

## Used by
None.

## Related
[`Audience.create`](/code/apps/ads/create-audience) · [`Campaign.create`](/code/apps/ads/create-campaign) · [`Campaign.update`](/code/apps/ads/update-campaign) · [`Ad.create`](/code/apps/ads/create-ad) · [`Mandate.spend`](/code/apps/ads/spend)