ConsentRecord
One entry of the consent ledger (1.61.0): append-only, kept 5 years (a target; verify with counsel), never its address.
An object with 17 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
applied_channels | array of ConsentChannel | yes | The channels whose state the record set: the channel itself, and under revocation_scope: all_channels every address channel of an Organization-scope opt-out. |
basis | ConsentBasis or null | yes | |
channel | ConsentChannel | yes | |
contact_id | ContactId or null | yes | The Contact the record names or whose identity holds the address; or null. |
environment | Environment | yes | |
evidence | ConsentEvidence or null | yes | |
id | ConsentRecordId | yes | |
identity_id | ContactIdentityId or null | yes | The identity of that Contact that holds the address; null for memory. |
object | "consent_record" | yes | |
occurred_at | Timestamp | yes | |
purpose | ConsentPurpose | yes | |
recorded_at | Timestamp | yes | |
recorded_by | ActorRef | yes | |
scope | ConsentScope | yes | |
sender | ConsentSender or null | yes | |
source | ConsentSource | yes | |
state | ConsentStateValue | yes |
Used by
The operations whose parameters, request body or responses name this shape directly.