Consent methods: withdraw
The Consent Verbs withdraw as typed SDK methods, with inputs, result, refusals and an example.
Reference for Consent, one group of Consent methods.
Consent.withdraw
Withdraw ends a Consent at once: processing for its Purpose stops, and the record is kept. Verb page.
interface ConsentVerbs {
withdraw(input: ConsentWithdrawInput, options?: SB.CallOptions): SB.Call<Consent>
}Emits Consent.withdrawn.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
consent | Consent | required | The Consent to end. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
consent | Consent | required | The withdrawn 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. | None. |
| 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. | None. |
Example
import { $ } from 'startup-builder'
const consent = await $.Consent.withdraw({ consent: 'consent_lMkrg7nUGY' })