Mail-merge export of one of your lists (account required; included for subscribers, per row otherwise)
A mail-merge CSV of one of the caller's own lists: one row per MAILING ADDRESS (owner, mailing line1 / city / state / ZIP, the property address(es), their canonical ids, stage, source, as_of, as_of_basis, grade). Every address is read from ONE address column family of a parcel's record, with its ZIP; only mail-ready addresses become rows, and X-Export-Parcels-Not-Mail-Ready counts the rest.
ACCOUNT REQUIRED: an API key or a signed-in session; anonymous callers -- including x402 / credit-token wallets -- get HTTP 401 code: "account_required" before any read. The list must be the caller's own (404 otherwise).
PRICE: INCLUDED for a paid PropRaven subscription. Any other account pays $0.10 per mailing row, the quote capped at $20, from a prepaid credit balance (X-CREDIT-TOKEN) or per call via x402 (X-PAYMENT, sent with your credentials); with neither, HTTP 402 carrying the exact quote. preview=true returns the row count and the quote, free, with no data.
Each export is recorded in PropRaven's people-data access log BEFORE the CSV is returned (and before an x402 payment settles). If the log cannot be written the export is refused (503) and any charge refunded or released.
Request
- Base URL: https://propraven.com
- URL: https://propraven.com/api/v1/cohorts/{id}/export
- Auth: HTTP bearer
Path parameters
The list (cohort) id.
Query parameters
true -> the free row count and exact quote, no data.
Headers
A prepaid credit token (pzc_...) to draw the per-row price from.
x402 payment for the quoted total, sent together with your account credentials.
Response
The mail-merge CSV (or, with preview=true, a JSON count + quote).
preview=true: { preview, parcels_listed, parcels_mail_ready, parcels_not_mail_ready, mailing_rows, truncated, quote, note }.
Changes
No recorded changes to this operation across all 1 revision of this API.