ConsentPanel

object

contactrequired: object
contact.idrequired: Id
Opaque record id.
contact.namerequired: string
contact.dndrequired: boolean
contact.blockedrequired: boolean
contact.phonesrequired: array of object
contact.phones[].e164required: string or null
contact.phones[].is_primaryrequired: boolean
contact.phones[].is_whatsapprequired: boolean or null
contact.emailrequired: string or null
enquiry_windowrequired: object
enquiry_window.last_enquiry_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
enquiry_window.ends_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
enquiry_window.openrequired: boolean
matrixrequired: array of object
matrix[].channelrequired: "whatsapp" | "sms" | "call" | "email"
matrix[].purposerequired: "service" | "promotional"
matrix[].staterequired: "granted" | "withdrawn" | "expired" | "none"
matrix[].basisrequired: string or null
matrix[].sourcerequired: string or null
matrix[].consent_idrequired: Id or null
Opaque record id.
matrix[].captured_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
matrix[].expires_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
matrix[].withdrawn_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
matrix[].dlt_consent_refrequired: string or null
suppressionsrequired: array of Suppression
historyrequired: array of Consent

Example

{
  "contact": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "dnd": true,
    "blocked": true,
    "phones": [
      {
        "e164": "string",
        "is_primary": true,
        "is_whatsapp": true
      }
    ],
    "email": "string"
  },
  "enquiry_window": {
    "last_enquiry_at": "2026-10-06T05:30:00.000Z",
    "ends_at": "2026-10-06T05:30:00.000Z",
    "open": true
  },
  "matrix": [
    {
      "channel": "whatsapp",
      "purpose": "service",
      "state": "granted",
      "basis": "string",
      "source": "string",
      "consent_id": "cmusrceel0000q7kaafxqi1om",
      "captured_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "withdrawn_at": "2026-10-06T05:30:00.000Z",
      "dlt_consent_ref": "string"
    }
  ],
  "suppressions": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "channel": "string",
      "address": "string",
      "contact_id": "cmusrceel0000q7kaafxqi1om",
      "reason": "string",
      "source": "string",
      "note": "string",
      "since": "2026-10-06T05:30:00.000Z"
    }
  ],
  "history": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "contact_id": "cmusrceel0000q7kaafxqi1om",
      "phone_e164": "string",
      "email": "string",
      "channel": "string",
      "purpose": "string",
      "status": "string",
      "basis": "string",
      "source": "string",
      "proof_ref": "string",
      "evidence": {},
      "dlt_consent_ref": "string",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "withdrawn_at": "2026-10-06T05:30:00.000Z",
      "captured_at": "2026-10-06T05:30:00.000Z"
    }
  ]
}

{ "contact": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "dnd": true, "blocked": true, "phones": [ { "e164": "string", "is_primary": true, "is_whatsapp": true } ], "email": "string" }, "enquiry_window": { "last_enquiry_at": "2026-10-06T05:30:00.000Z", "ends_at": "2026-10-06T05:30:00.000Z", "open": true }, "matrix": [ { "channel": "whatsapp", "purpose": "service", "state": "granted", "basis": "string", "source": "string", "consent_id": "cmusrceel0000q7kaafxqi1om", "captured_at": "2026-10-06T05:30:00.000Z", "expires_at": "2026-10-06T05:30:00.000Z", "withdrawn_at": "2026-10-06T05:30:00.000Z", "dlt_consent_ref": "string" } ], "suppressions": [ { "id": "cmusrceel0000q7kaafxqi1om", "channel": "string", "address": "string", "contact_id": "cmusrceel0000q7kaafxqi1om", "reason": "string", "source": "string", "note": "string", "since": "2026-10-06T05:30:00.000Z" } ], "history": [ { "id": "cmusrceel0000q7kaafxqi1om", "contact_id": "cmusrceel0000q7kaafxqi1om", "phone_e164": "string", "email": "string", "channel": "string", "purpose": "string", "status": "string", "basis": "string", "source": "string", "proof_ref": "string", "evidence": {}, "dlt_consent_ref": "string", "expires_at": "2026-10-06T05:30:00.000Z", "withdrawn_at": "2026-10-06T05:30:00.000Z", "captured_at": "2026-10-06T05:30:00.000Z" } ] }