Skip to content

by Startups.Studio

Legal & trust Consent

Consent.withdraw

POST /{namespace}/consents/{consent}/withdraw

Withdraw ends a Consent at once: processing for its Purpose stops, and the record is kept.

Noun: Consent
Mode: do
Event: Consent.withdrawn

You, to your agent

Withdraw the latest consent.

curl -X POST https://api.sb/tutorloop.com/consents/consent_1/withdraw \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const consent = await $.Consent.withdraw({ consent: 'consent_1' })

npx startup-builder do Consent.withdraw --json '{"consent":"consent_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Consent.withdraw({ consent: 'consent_1' })"
  }
}

Withdraw ends a Consent at once: processing for its Purpose stops, and the record stays as proof.

Inputs

Input	Type	Required	Description
`consent`	Consent	required	The Consent to end.

Outputs

Output	Type	Required	Description
`consent`	Consent	required	The withdrawn Consent.

Effects

Emits Consent.withdrawn.
Performed by the Privacy Officer.
Two-way: it runs at once, in the try, send and do modes.
Stops every queued Action that relies on the Consent.

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.	Consent.withdraw
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Consent.withdraw

When it waits

Gate	Default
Decision class	Medium: two-way, visible
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
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`.

Consent.update

Previous Page

Control

Next Page