ConsentRecordCreateRequest
Records one consent event (1.61.0): an opt-in or an opt-out of an address on a channel, or a grant or revocation of caller memory for a Contact. Its source is api for an API key and dashboard for a Member in a console session.
An object with 10 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
address | ConsentAddress | no | The address; required for every channel but memory, refused for memory. |
basis | ConsentBasis | no | Required for opted_in and granted, refused for opted_out and revoked. |
channel | ConsentChannel | yes | |
contact_id | ContactId | no | The Contact; required for memory, whose subject is a Contact. For an address channel it only links the record, and the Contact must hold the address (consent_contact_unknown otherwise). |
evidence | ConsentEvidenceInput | no | Required for an opt-in or a grant over an opted_out or revoked state (consent_evidence_required). |
occurred_at | RequestTimestamp | no | When the person acted; when the api records it if omitted. |
purpose | ConsentPurpose | no | all when omitted. |
scope | ConsentScope | no | organization when omitted. |
sender | ConsentSenderInput | no | Required with scope: sender, refused otherwise. |
state | ConsentStateValue | yes | An address channel takes opted_in or opted_out, memory takes granted or revoked. |
Used by
The operations whose parameters, request body or responses name this shape directly.