Consent

Consent ledger (DPDP / TRAI): grants, withdrawals, the contact consent panel and the suppression list.

GET/v1/consents

Consent ledger of a contact

Newest first; includes suppressions.

Access: API key with contacts:read, or a member session. Permission contacts.view.

Parameters

contact_idqueryrequired: Id
Opaque record id.
cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.

Response · 200

datarequired: array of Consent
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/consents' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/consents

Enquiry-based consent expires 7 days after the enquiry (TRAI TCCCPR, 18 Sep 2026). Members and API keys record sources manual, call, form or import (API keys also api); basis consent / legacy_registered needs proof.ref. A DLT consent ref, or a grant after the person opted out themselves (STOP, unsubscribe), needs privacy.consents, step-up and a reason — and, for the re-opt-in, proof of the person’s new request.

Access: API key with contacts:write, or a member session. Permission contacts.edit.

Request body

contact_idrequired: Id
Opaque record id.
channelrequired: ConsentChannel
purposerequired: ConsentPurpose
basisrequired: ConsentBasis
consent = explicit opt-in · enquiry = TRAI enquiry window (expires 7 days after the enquiry) · legitimate_use = DPDP §7 · contract = existing customer · legacy_registered = older consent registered on the operators’ platform.
sourcerequired: ConsentSource
proof: ConsentProof
dlt_consent_ref: string or null
captured_at: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
expires_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
reason: string or null
Required for a DLT ref or an opt-out override.

Response · 201

datarequired: Consent
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/consents' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"contact_id":"cmusrceel0000q7kaafxqi1om","channel":"whatsapp","purpose":"transactional","basis":"consent","source":"form","proof":{"ref":"string","form_id":"string","text_version":"string","ip":"string","user_agent":"string","message_id":"string","url":"string","note":"string"},"dlt_consent_ref":"string","captured_at":"2026-10-06T05:30:00.000Z","expires_at":"2026-10-06T05:30:00.000Z","reason":"string"}'

Response example

{
  "data": {
    "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"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/consents/contacts/{contactId}

Consent panel of a contact

Access: API key with contacts:read, or a member session. Permission contacts.view.

Parameters

contactIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: ConsentPanel
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/consents/contacts/{contactId}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "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"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/consents/export

Export a person’s consent records (DPDP)

Unmasked, for data-principal requests; audited.

Access: Signed-in members only (web or Android session) — not for API keys. Permission privacy.requests.

Request body

contact_id: Id
Opaque record id.
phone: string
email: string

Response · 200

datarequired: array of Consent
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/consents/export' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"contact_id":"cmusrceel0000q7kaafxqi1om","phone":"string","email":"string"}'

Response example

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/consents/suppressions

Suppression list

Addresses nothing is sent to on a channel (bounces, complaints, invalid numbers, manual).

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.communication.

Parameters

channelquery: "whatsapp" | "sms" | "email" | "all"
cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.

Response · 200

datarequired: array of Suppression
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/consents/suppressions' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "channel": "string",
      "address": "string",
      "contact_id": "cmusrceel0000q7kaafxqi1om",
      "reason": "string",
      "source": "string",
      "note": "string",
      "since": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/consents/suppressions

Suppress an address

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.communication.

Request body

channelrequired: "whatsapp" | "sms" | "email" | "all"
addressrequired: string
Phone (any format) or email.
reason: "hard_bounce" | "complaint" | "invalid_number" | "blocked_by_recipient" | "manual"
note: string or null

Response · 201

datarequired: Suppression
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/consents/suppressions' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"channel":"whatsapp","address":"string","reason":"manual","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "string",
    "address": "string",
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "reason": "string",
    "source": "string",
    "note": "string",
    "since": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/consents/suppressions/lift

Lift a suppression

A DPDP erasure block cannot be lifted (403). Complaint and blocked-by-recipient blocks need a note (why) and step-up.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.communication.

Request body

channelrequired: "whatsapp" | "sms" | "email" | "all"
addressrequired: string
Phone (any format) or email.
note: string or null

Response · 200

datarequired: Suppression
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/consents/suppressions/lift' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"channel":"whatsapp","address":"string","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "string",
    "address": "string",
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "reason": "string",
    "source": "string",
    "note": "string",
    "since": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/consents/withdraw

Record a withdrawal (opt-out)

Defaults to every channel and every non-transactional purpose, like STOP.

Access: API key with contacts:read, or a member session. Permission contacts.view.

Request body

contact_idrequired: Id
Opaque record id.
channel: ConsentChannel
purpose: ConsentPurpose
source: ConsentSource
proof: ConsentProof

Response · 201

datarequired: Consent
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/consents/withdraw' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"contact_id":"cmusrceel0000q7kaafxqi1om","channel":"whatsapp","purpose":"transactional","source":"form","proof":{"ref":"string","form_id":"string","text_version":"string","ip":"string","user_agent":"string","message_id":"string","url":"string","note":"string"}}'

Response example

{
  "data": {
    "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"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": [ { "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" } ], "meta": { "next_cursor": "string", "has_more": true } }

curl -X POST 'https://api.propzolo.com/v1/consents' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"contact_id":"cmusrceel0000q7kaafxqi1om","channel":"whatsapp","purpose":"transactional","basis":"consent","source":"form","proof":{"ref":"string","form_id":"string","text_version":"string","ip":"string","user_agent":"string","message_id":"string","url":"string","note":"string"},"dlt_consent_ref":"string","captured_at":"2026-10-06T05:30:00.000Z","expires_at":"2026-10-06T05:30:00.000Z","reason":"string"}'

{ "data": { "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" }, "meta": {} }

{ "data": { "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" } ] }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/consents/export' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"contact_id":"cmusrceel0000q7kaafxqi1om","phone":"string","email":"string"}'

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "channel": "string", "address": "string", "contact_id": "cmusrceel0000q7kaafxqi1om", "reason": "string", "source": "string", "note": "string", "since": "2026-10-06T05:30:00.000Z" } ], "meta": { "next_cursor": "string", "has_more": true } }

curl -X POST 'https://api.propzolo.com/v1/consents/suppressions' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"channel":"whatsapp","address":"string","reason":"manual","note":"string"}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "channel": "string", "address": "string", "contact_id": "cmusrceel0000q7kaafxqi1om", "reason": "string", "source": "string", "note": "string", "since": "2026-10-06T05:30:00.000Z" }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/consents/suppressions/lift' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"channel":"whatsapp","address":"string","note":"string"}'

curl -X POST 'https://api.propzolo.com/v1/consents/withdraw' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"contact_id":"cmusrceel0000q7kaafxqi1om","channel":"whatsapp","purpose":"transactional","source":"form","proof":{"ref":"string","form_id":"string","text_version":"string","ip":"string","user_agent":"string","message_id":"string","url":"string","note":"string"}}'