ConsentState
The derived state of one channel, subject, scope and purpose (1.61.0), changed in the transaction that records a consent event and read by admission and the send path.
An object with 10 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
channel | ConsentChannel | yes | |
identity_id | ContactIdentityId or null | yes | The identity of the Contact whose address it is about; null for memory. |
object | "consent_state" | yes | |
purpose | ConsentPurpose | yes | |
record_id | ConsentRecordId | yes | The record that set the state. |
scope | ConsentScope | yes | |
sender | ConsentSender or null | yes | |
source | ConsentSource | no | Where the record that set the state came from (1.62.0); GET /v1/consent-records/{consent_record_id} reads the record with its evidence. Absent from an api before 1.62.0. |
state | ConsentStateValue | yes | |
updated_at | Timestamp | yes |