URL: /code/apps/mailboxes/withdraw · Id: `page:/code/apps/mailboxes/withdraw`

# Consent.withdraw

> Ends a Consent at once: sending for its purpose stops, and the record stays.

POST https://api.sb/{your-domain}/consents/{consent}/withdraw

Ends a [Consent](https://startupbuilder.dev/business/nouns/consent) at once: sending for its purpose stops, and the record stays.

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

```text title="Run it · Ask"
Maria withdrew her consent to the product-update emails.
```

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

const result = await $.try.Consent.withdraw({ consent: 'https://api.sb/leaseline.app/consents/consent_Mc7uP3dT9e' })
```

```json title="Run it · Response"
{
  "api": "https://api.sb/leaseline.app",
  "consent": {
    "$id": "https://api.sb/leaseline.app/consents/consent_Mc7uP3dT9e",
    "$type": "Consent",
    "state": "withdrawn",
    "purpose": "product-updates"
  },
  "action": {
    "operation": "Consent.withdraw",
    "mode": "try",
    "status": "done"
  }
}
```

Its Inputs, Outputs, Effects and guards quote [the hub’s `Consent.withdraw`](https://startupbuilder.dev/business/nouns/consent/withdraw); this page adds what each Venue honors, its limits and a worked call. It is one of the [Verbs](https://startupbuilder.dev/business/nouns/verb) of [Mailboxes](/code/apps/mailboxes#verbs).

## Inputs
| Name | Type | Default | Meaning |
| --- | --- | --- | --- |
| `consent` | `Consent` | Required | The Consent to end. |

## Outputs
| Field | Type | What `null` means |
| --- | --- | --- |
| `consent` | `Consent` | Never null: the withdrawn Consent. |

## 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; `Consent.withdrawn` 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**

Stops every queued Action that relies on the Consent.

**Emits**

`Consent.withdrawn` with `{ consent }`

**Performed by**

[Privacy Officer](https://startupbuilder.dev/agents/legal/privacy-officer)

**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 `Consent.withdrawn` delivers the result.

**Ask**

```text
Maria withdrew her consent to the product-update emails.
```

**API**

```bash
curl -X POST "https://api.sb/leaseline.app/consents/consent_Mc7uP3dT9e/withdraw?mode=send" \
  -H "Authorization: Bearer $SB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**CLI**

```bash
npx startup-builder do Consent.withdraw --send --data '{}'
```

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

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "mode": "send",
    "code": "return await $.Consent.withdraw({})"
  }
}
```

**SDK**

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

const result = await $.send.Consent.withdraw({
  consent: 'https://api.sb/leaseline.app/consents/consent_Mc7uP3dT9e',
})
```


```json title="Response, in send mode"
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Consent.withdraw",
    "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
[`Message.broadcast`](/code/apps/mailboxes/broadcast) · [`Message.schedule`](/code/apps/mailboxes/schedule) · [`Mailbox.warm`](/code/apps/mailboxes/warm) · [`Mailbox.rest`](/code/apps/mailboxes/rest) · [`Domain.authenticate`](/code/apps/mailboxes/authenticate) · [`Mailbox.retire`](/code/apps/mailboxes/retire) · [`Contact.suppress`](/code/apps/mailboxes/suppress) · [`Contact.unsubscribe`](/code/apps/mailboxes/unsubscribe)