TextKitDocs

Export the suppression list, or the full consent ledger with opt-in proof, as CSV

GET/v1/consent/export

Query Parameters

  • typesuppressions, ledger

    Default "suppressions".

Responses

  • 200text/csv

    suppressions: phone,status,updated_at,via,method,detected. ledger: phone,at,type,via,method,detected,note,proof_source,proof_collected_at,proof_page_url,proof_disclosure,proof_ip,proof_user_agent,proof_registration_id,proof_campaign_id

  • 401Error

    Missing, malformed, or revoked API key

  • 402Error

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429Error

    Rate limit or quota exceeded

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

  • 401

    Missing, malformed, or revoked API key

  • 402

    Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged

  • 429

    Rate limit or quota exceeded