Skip to content

Consent methods: update

The Consent Verbs update as typed SDK methods, with inputs, result, refusals and an example.

Reference for Consent, one group of Consent methods.

Consent.update

Changes the given properties of a Consent. Verb page.

TypeScript
interface ConsentVerbs {
  update(input: ConsentUpdateInput, options?: SB.CallOptions): SB.Call<Consent>
}

Emits Consent.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Consent.
basisstringThe lawful basis, such as consent or contract. Never randomized.
regionstringThe jurisdiction whose rules apply. Never randomized.
withdrawnAtdatetimeWhen the person withdrew it. Never randomized.

Returns

OutputTypeRequiredDescription
consentConsentrequiredThe Consent.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

TypeScript
import { $ } from 'startup-builder'

const consent = await $.Consent.update({ id: 'consent_lMkrg7nUGY', withdrawnAt: '2026-10-22T12:00:00Z' })