Owner reports

Live listing performance for owners on a magic-link page (views, enquiries, visits, feedback, offers), the periodic report by email or WhatsApp, links (issue, renew, rotate, revoke) and lines curated for owners.

GET/v1/contacts/{id}/owner-report

An owner’s reports

Their listings, report links (URLs for what the caller manages), the periodic report choice and sends.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ContactOwnerReport
metarequired: object

Request

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

Response example

{
  "data": {
    "owner_contact_id": "cmusrceel0000q7kaafxqi1om",
    "listings": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref_code": "string",
        "title": "string",
        "status": "string",
        "managed": true
      }
    ],
    "owner_wide": true,
    "stopped": true,
    "digest_enabled": true,
    "links": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "scope": "owner",
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "listing": {
          "ref_code": "string",
          "title": "string"
        },
        "state": "active",
        "issued_via": "string",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "expires_text": "string",
        "renewed_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z",
        "revoke_reason": "string",
        "replaced_by_id": "cmusrceel0000q7kaafxqi1om",
        "open_count": 0,
        "first_opened_at": "2026-10-06T05:30:00.000Z",
        "last_opened_at": "2026-10-06T05:30:00.000Z",
        "last_device": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "url": "string"
      }
    ],
    "sends": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "string",
        "period_key": "string",
        "status": "string",
        "channel": "string",
        "blocked_reason": "string",
        "created_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.

PUT/v1/contacts/{id}/owner-report/digest

Stop or resume an owner’s periodic report

Records the owner’s wish (told to their agent). Audited.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

stoppedrequired: boolean

Response · 200

datarequired: ContactOwnerReport
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/contacts/{id}/owner-report/digest' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"stopped":true}'

Response example

{
  "data": {
    "owner_contact_id": "cmusrceel0000q7kaafxqi1om",
    "listings": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref_code": "string",
        "title": "string",
        "status": "string",
        "managed": true
      }
    ],
    "owner_wide": true,
    "stopped": true,
    "digest_enabled": true,
    "links": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "scope": "owner",
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "listing": {
          "ref_code": "string",
          "title": "string"
        },
        "state": "active",
        "issued_via": "string",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "expires_text": "string",
        "renewed_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z",
        "revoke_reason": "string",
        "replaced_by_id": "cmusrceel0000q7kaafxqi1om",
        "open_count": 0,
        "first_opened_at": "2026-10-06T05:30:00.000Z",
        "last_opened_at": "2026-10-06T05:30:00.000Z",
        "last_device": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "url": "string"
      }
    ],
    "sends": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "string",
        "period_key": "string",
        "status": "string",
        "channel": "string",
        "blocked_reason": "string",
        "created_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.
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.

PATCH/v1/owner-reports/entries/{id}

Change, show or hide a line for the owner

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

text: string
action_kind: "open_house" | "price_advice" | "marketing" | "photos" | "note" or null
occurred_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
status: "draft" | "published"

Response · 200

datarequired: OwnerReportEntry
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/owner-reports/entries/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"text":"string","action_kind":"open_house","occurred_on":"2026-10-06","status":"draft"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "property_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "feedback",
    "action_kind": "open_house",
    "text": "string",
    "occurred_on": "2026-10-06",
    "status": "draft",
    "source": "string",
    "visit_item_id": "cmusrceel0000q7kaafxqi1om",
    "published_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_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.
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.

DELETE/v1/owner-reports/entries/{id}

Remove a line for the owner

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/owner-reports/entries/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "deleted": true
  },
  "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/owner-reports/links

Get the owner’s report link

The live link for a listing (scope listing) or every listing of its owner (scope owner, from a listing or the owner contact): the existing one when there is one (renewed if it expired), else a new one.

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

Request body

scoperequired: "listing" | "owner"
property_id: Id or null
Opaque record id.
owner_contact_id: Id or null
Opaque record id.
days: integer or null

Response · 200

datarequired: OwnerReportLink
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/owner-reports/links' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"scope":"listing","property_id":"cmusrceel0000q7kaafxqi1om","owner_contact_id":"cmusrceel0000q7kaafxqi1om","days":7}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "scope": "owner",
    "property_id": "cmusrceel0000q7kaafxqi1om",
    "listing": {
      "ref_code": "string",
      "title": "string"
    },
    "state": "active",
    "issued_via": "string",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "expires_text": "string",
    "renewed_at": "2026-10-06T05:30:00.000Z",
    "revoked_at": "2026-10-06T05:30:00.000Z",
    "revoke_reason": "string",
    "replaced_by_id": "cmusrceel0000q7kaafxqi1om",
    "open_count": 0,
    "first_opened_at": "2026-10-06T05:30:00.000Z",
    "last_opened_at": "2026-10-06T05:30:00.000Z",
    "last_device": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "url": "string"
  },
  "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/owner-reports/links/{id}/renew

Renew an owner report link

The same URL works again for the company’s link lifetime (or `days`). A revoked link cannot be renewed.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

days: integer or null

Response · 200

datarequired: OwnerReportLink
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/owner-reports/links/{id}/renew' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"days":7}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "scope": "owner",
    "property_id": "cmusrceel0000q7kaafxqi1om",
    "listing": {
      "ref_code": "string",
      "title": "string"
    },
    "state": "active",
    "issued_via": "string",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "expires_text": "string",
    "renewed_at": "2026-10-06T05:30:00.000Z",
    "revoked_at": "2026-10-06T05:30:00.000Z",
    "revoke_reason": "string",
    "replaced_by_id": "cmusrceel0000q7kaafxqi1om",
    "open_count": 0,
    "first_opened_at": "2026-10-06T05:30:00.000Z",
    "last_opened_at": "2026-10-06T05:30:00.000Z",
    "last_device": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "url": "string"
  },
  "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.
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/owner-reports/links/{id}/revoke

Revoke an owner report link

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: OwnerReportLink
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/owner-reports/links/{id}/revoke' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "scope": "owner",
    "property_id": "cmusrceel0000q7kaafxqi1om",
    "listing": {
      "ref_code": "string",
      "title": "string"
    },
    "state": "active",
    "issued_via": "string",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "expires_text": "string",
    "renewed_at": "2026-10-06T05:30:00.000Z",
    "revoked_at": "2026-10-06T05:30:00.000Z",
    "revoke_reason": "string",
    "replaced_by_id": "cmusrceel0000q7kaafxqi1om",
    "open_count": 0,
    "first_opened_at": "2026-10-06T05:30:00.000Z",
    "last_opened_at": "2026-10-06T05:30:00.000Z",
    "last_device": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "url": "string"
  },
  "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/owner-reports/links/{id}/rotate

Replace an owner report link

Revokes the link (the old URL stops working at once) and returns a new one for the same owner and scope.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: OwnerReportLink
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/owner-reports/links/{id}/rotate' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "scope": "owner",
    "property_id": "cmusrceel0000q7kaafxqi1om",
    "listing": {
      "ref_code": "string",
      "title": "string"
    },
    "state": "active",
    "issued_via": "string",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "expires_text": "string",
    "renewed_at": "2026-10-06T05:30:00.000Z",
    "revoked_at": "2026-10-06T05:30:00.000Z",
    "revoke_reason": "string",
    "replaced_by_id": "cmusrceel0000q7kaafxqi1om",
    "open_count": 0,
    "first_opened_at": "2026-10-06T05:30:00.000Z",
    "last_opened_at": "2026-10-06T05:30:00.000Z",
    "last_device": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "url": "string"
  },
  "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/owner-reports/links/{id}/send

Send the owner their report now

Through the compliance-gated pipeline (a service message to an existing client); the link is minted at delivery.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

channel: "auto" | "email" | "whatsapp_cloud" | "sms" or null

Response · 200

datarequired: OwnerReportSendResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/owner-reports/links/{id}/send' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"channel":"auto"}'

Response example

{
  "data": {
    "status": "queued",
    "send_id": "cmusrceel0000q7kaafxqi1om",
    "channel": "string",
    "reason": "string"
  },
  "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.
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/owner-reports/settings

Owner report settings

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

Response · 200

datarequired: object
data.digest_enabledrequired: boolean
Send owners a periodic report (off by default).
data.cadencerequired: "weekly" | "monthly"
data.weekdayrequired: integer
Weekly: 1 = Monday … 7 = Sunday.
data.month_dayrequired: integer
Monthly: the day of the month (1–28).
data.send_timerequired: string
HH:mm on the company clock.
data.channelrequired: "email" | "whatsapp_cloud" | "auto"
email · whatsapp_cloud (the approved owner_report template) · auto (the best reachable channel)
data.link_daysrequired: integer
How long a new link works (default 90).
data.sectionsrequired: OwnerReportSections
Which sections the owner sees.
data.schedule_textrequired: string
"Every Monday at 10:00".
metarequired: object

Request

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

Response example

{
  "data": {
    "digest_enabled": true,
    "cadence": "weekly",
    "weekday": 1,
    "month_day": 1,
    "send_time": "string",
    "channel": "email",
    "link_days": 7,
    "sections": {
      "price": true,
      "views": true,
      "enquiries": true,
      "visits": true,
      "feedback": true,
      "offers": true,
      "matches": true,
      "activity": true
    },
    "schedule_text": "string"
  },
  "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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/owner-reports/settings

Change owner report settings

The periodic digest is off until switched on; sections are the defaults each listing may override.

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

Request body

digest_enabled: boolean
Send owners a periodic report (off by default).
cadence: "weekly" | "monthly"
weekday: integer
Weekly: 1 = Monday … 7 = Sunday.
month_day: integer
Monthly: the day of the month (1–28).
send_time: string
HH:mm on the company clock.
channel: "email" | "whatsapp_cloud" | "auto"
email · whatsapp_cloud (the approved owner_report template) · auto (the best reachable channel)
link_days: integer
How long a new link works (default 90).
sections: object
sections.price: boolean
sections.views: boolean
sections.enquiries: boolean
sections.visits: boolean
sections.feedback: boolean
sections.offers: boolean
sections.matches: boolean
sections.activity: boolean

Response · 200

datarequired: object
data.digest_enabledrequired: boolean
Send owners a periodic report (off by default).
data.cadencerequired: "weekly" | "monthly"
data.weekdayrequired: integer
Weekly: 1 = Monday … 7 = Sunday.
data.month_dayrequired: integer
Monthly: the day of the month (1–28).
data.send_timerequired: string
HH:mm on the company clock.
data.channelrequired: "email" | "whatsapp_cloud" | "auto"
email · whatsapp_cloud (the approved owner_report template) · auto (the best reachable channel)
data.link_daysrequired: integer
How long a new link works (default 90).
data.sectionsrequired: OwnerReportSections
Which sections the owner sees.
data.schedule_textrequired: string
"Every Monday at 10:00".
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/owner-reports/settings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"digest_enabled":true,"cadence":"weekly","weekday":1,"month_day":1,"send_time":"string","channel":"email","link_days":7,"sections":{"price":true,"views":true,"enquiries":true,"visits":true,"feedback":true,"offers":true,"matches":true,"activity":true}}'

Response example

{
  "data": {
    "digest_enabled": true,
    "cadence": "weekly",
    "weekday": 1,
    "month_day": 1,
    "send_time": "string",
    "channel": "email",
    "link_days": 7,
    "sections": {
      "price": true,
      "views": true,
      "enquiries": true,
      "visits": true,
      "feedback": true,
      "offers": true,
      "matches": true,
      "activity": true
    },
    "schedule_text": "string"
  },
  "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/properties/{id}/owner-report

A listing’s owner report panel

Links, the listing’s choices, curated lines, visit feedback to draft from and the reports sent.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: ListingOwnerReport
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/properties/{id}/owner-report' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "property_id": "cmusrceel0000q7kaafxqi1om",
    "ref_code": "string",
    "title": "string",
    "status": "string",
    "reportable": true,
    "owner": {
      "present": true,
      "name": "string",
      "stopped": true,
      "owner_wide": true
    },
    "settings": {
      "digest_opt_out": true,
      "opted_out_by": "string",
      "opted_out_at": "2026-10-06T05:30:00.000Z",
      "sections": {
        "price": true,
        "views": true,
        "enquiries": true,
        "visits": true,
        "feedback": true,
        "offers": true,
        "matches": true,
        "activity": true
      },
      "overrides": {
        "price": true,
        "views": true,
        "enquiries": true,
        "visits": true,
        "feedback": true,
        "offers": true,
        "matches": true,
        "activity": true
      }
    },
    "company": {
      "digest_enabled": true,
      "schedule": "string",
      "channel": "string",
      "sections": {
        "price": true,
        "views": true,
        "enquiries": true,
        "visits": true,
        "feedback": true,
        "offers": true,
        "matches": true,
        "activity": true
      }
    },
    "links": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "scope": "owner",
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "listing": {
          "ref_code": "string",
          "title": "string"
        },
        "state": "active",
        "issued_via": "string",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "expires_text": "string",
        "renewed_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z",
        "revoke_reason": "string",
        "replaced_by_id": "cmusrceel0000q7kaafxqi1om",
        "open_count": 0,
        "first_opened_at": "2026-10-06T05:30:00.000Z",
        "last_opened_at": "2026-10-06T05:30:00.000Z",
        "last_device": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "url": "string"
      }
    ],
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "kind": "feedback",
        "action_kind": "open_house",
        "text": "string",
        "occurred_on": "2026-10-06",
        "status": "draft",
        "source": "string",
        "visit_item_id": "cmusrceel0000q7kaafxqi1om",
        "published_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z",
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "visit_feedback": [
      {
        "visit_item_id": "cmusrceel0000q7kaafxqi1om",
        "visited_on": "2026-10-06",
        "reaction": "string",
        "reasons": [
          "string"
        ],
        "remarks": "string",
        "suggested_text": "string",
        "added": true
      }
    ],
    "sends": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "string",
        "period_key": "string",
        "status": "string",
        "channel": "string",
        "blocked_reason": "string",
        "created_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.

PATCH/v1/properties/{id}/owner-report

Change a listing’s owner report choices

Take the listing out of the periodic report, or choose the sections its owner sees (null: defaults).

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

digest_opt_out: boolean
sections: object or null
sections.price: boolean
sections.views: boolean
sections.enquiries: boolean
sections.visits: boolean
sections.feedback: boolean
sections.offers: boolean
sections.matches: boolean
sections.activity: boolean

Response · 200

datarequired: ListingOwnerReport
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/properties/{id}/owner-report' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"digest_opt_out":true,"sections":{"price":true,"views":true,"enquiries":true,"visits":true,"feedback":true,"offers":true,"matches":true,"activity":true}}'

Response example

{
  "data": {
    "property_id": "cmusrceel0000q7kaafxqi1om",
    "ref_code": "string",
    "title": "string",
    "status": "string",
    "reportable": true,
    "owner": {
      "present": true,
      "name": "string",
      "stopped": true,
      "owner_wide": true
    },
    "settings": {
      "digest_opt_out": true,
      "opted_out_by": "string",
      "opted_out_at": "2026-10-06T05:30:00.000Z",
      "sections": {
        "price": true,
        "views": true,
        "enquiries": true,
        "visits": true,
        "feedback": true,
        "offers": true,
        "matches": true,
        "activity": true
      },
      "overrides": {
        "price": true,
        "views": true,
        "enquiries": true,
        "visits": true,
        "feedback": true,
        "offers": true,
        "matches": true,
        "activity": true
      }
    },
    "company": {
      "digest_enabled": true,
      "schedule": "string",
      "channel": "string",
      "sections": {
        "price": true,
        "views": true,
        "enquiries": true,
        "visits": true,
        "feedback": true,
        "offers": true,
        "matches": true,
        "activity": true
      }
    },
    "links": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "scope": "owner",
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "listing": {
          "ref_code": "string",
          "title": "string"
        },
        "state": "active",
        "issued_via": "string",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "expires_text": "string",
        "renewed_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z",
        "revoke_reason": "string",
        "replaced_by_id": "cmusrceel0000q7kaafxqi1om",
        "open_count": 0,
        "first_opened_at": "2026-10-06T05:30:00.000Z",
        "last_opened_at": "2026-10-06T05:30:00.000Z",
        "last_device": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "url": "string"
      }
    ],
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "kind": "feedback",
        "action_kind": "open_house",
        "text": "string",
        "occurred_on": "2026-10-06",
        "status": "draft",
        "source": "string",
        "visit_item_id": "cmusrceel0000q7kaafxqi1om",
        "published_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z",
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "visit_feedback": [
      {
        "visit_item_id": "cmusrceel0000q7kaafxqi1om",
        "visited_on": "2026-10-06",
        "reaction": "string",
        "reasons": [
          "string"
        ],
        "remarks": "string",
        "suggested_text": "string",
        "added": true
      }
    ],
    "sends": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "string",
        "period_key": "string",
        "status": "string",
        "channel": "string",
        "blocked_reason": "string",
        "created_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.
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/properties/{id}/owner-report/entries

Add a line for the owner

Visit feedback in the agent’s words or an update (open house, price advice …); phone numbers and emails are masked.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

kindrequired: "feedback" | "action"
action_kind: "open_house" | "price_advice" | "marketing" | "photos" | "note" or null
textrequired: string
occurred_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
status: "draft" | "published"
visit_item_id: Id or null
Opaque record id.

Response · 201

datarequired: OwnerReportEntry
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/properties/{id}/owner-report/entries' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"feedback","action_kind":"open_house","text":"string","occurred_on":"2026-10-06","status":"draft","visit_item_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "property_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "feedback",
    "action_kind": "open_house",
    "text": "string",
    "occurred_on": "2026-10-06",
    "status": "draft",
    "source": "string",
    "visit_item_id": "cmusrceel0000q7kaafxqi1om",
    "published_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_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.
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/properties/{id}/owner-report/preview

Preview the owner’s report

Exactly what the owner sees: this listing, or (scope=owner) every listing of the owner.

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

Parameters

idpathrequired: Id
Opaque record id.
scopequery: "listing" | "owner"

Response · 200

datarequired: OwnerReportPage
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/properties/{id}/owner-report/preview' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "scope": "owner",
    "preview": true,
    "company": {
      "name": "string",
      "brand_color": "string",
      "logo_url": "string",
      "phone": "string"
    },
    "owner_first_name": "string",
    "updated_text": "string",
    "expires_text": "string",
    "weeks": [
      {
        "key": "string",
        "label": "string"
      }
    ],
    "listings": [
      {
        "ref_code": "string",
        "title": "string",
        "place": "string",
        "rental": true,
        "status": "string",
        "status_label": "string",
        "listed_on": "string",
        "days_on_market": 0,
        "price": {
          "amount": 850000000,
          "per_month": true,
          "on_request": true,
          "history": [
            {
              "on": null,
              "amount": null,
              "previous": null
            }
          ]
        },
        "views": {
          "total": 0,
          "by_week": [
            0
          ],
          "shared_with": 0,
          "shared_by_week": [
            0
          ]
        },
        "enquiries": {
          "total": 0,
          "by_week": [
            0
          ],
          "sources": [
            {
              "label": null,
              "count": null
            }
          ]
        },
        "visits": {
          "done": 0,
          "upcoming": 0,
          "by_week": [
            0
          ],
          "next": "string"
        },
        "feedback": {
          "responses": 0,
          "liked": 0,
          "maybe": 0,
          "disliked": 0,
          "themes": [
            {
              "key": null,
              "label": null,
              "count": null
            }
          ],
          "lines": [
            {
              "on": null,
              "text": null
            }
          ]
        },
        "offers": [
          {
            "title": "string",
            "status": "string",
            "amount": 850000000,
            "per_month": true,
            "on": "string"
          }
        ],
        "matches": {
          "count": 0
        },
        "activity": [
          {
            "on": "string",
            "label": "string",
            "text": "string"
          }
        ],
        "agent": {
          "name": "string",
          "designation": "string",
          "phone": "string",
          "photo_url": "string"
        }
      }
    ],
    "digest": {
      "on": true,
      "schedule": "string",
      "stopped": true
    }
  },
  "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.

{ "data": { "owner_contact_id": "cmusrceel0000q7kaafxqi1om", "listings": [ { "id": "cmusrceel0000q7kaafxqi1om", "ref_code": "string", "title": "string", "status": "string", "managed": true } ], "owner_wide": true, "stopped": true, "digest_enabled": true, "links": [ { "id": "cmusrceel0000q7kaafxqi1om", "scope": "owner", "property_id": "cmusrceel0000q7kaafxqi1om", "listing": { "ref_code": "string", "title": "string" }, "state": "active", "issued_via": "string", "expires_at": "2026-10-06T05:30:00.000Z", "expires_text": "string", "renewed_at": "2026-10-06T05:30:00.000Z", "revoked_at": "2026-10-06T05:30:00.000Z", "revoke_reason": "string", "replaced_by_id": "cmusrceel0000q7kaafxqi1om", "open_count": 0, "first_opened_at": "2026-10-06T05:30:00.000Z", "last_opened_at": "2026-10-06T05:30:00.000Z", "last_device": "string", "created_at": "2026-10-06T05:30:00.000Z", "url": "string" } ], "sends": [ { "id": "cmusrceel0000q7kaafxqi1om", "kind": "string", "period_key": "string", "status": "string", "channel": "string", "blocked_reason": "string", "created_at": "2026-10-06T05:30:00.000Z" } ] }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/owner-reports/entries/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"text":"string","action_kind":"open_house","occurred_on":"2026-10-06","status":"draft"}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "property_id": "cmusrceel0000q7kaafxqi1om", "kind": "feedback", "action_kind": "open_house", "text": "string", "occurred_on": "2026-10-06", "status": "draft", "source": "string", "visit_item_id": "cmusrceel0000q7kaafxqi1om", "published_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/owner-reports/links' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"scope":"listing","property_id":"cmusrceel0000q7kaafxqi1om","owner_contact_id":"cmusrceel0000q7kaafxqi1om","days":7}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "scope": "owner", "property_id": "cmusrceel0000q7kaafxqi1om", "listing": { "ref_code": "string", "title": "string" }, "state": "active", "issued_via": "string", "expires_at": "2026-10-06T05:30:00.000Z", "expires_text": "string", "renewed_at": "2026-10-06T05:30:00.000Z", "revoked_at": "2026-10-06T05:30:00.000Z", "revoke_reason": "string", "replaced_by_id": "cmusrceel0000q7kaafxqi1om", "open_count": 0, "first_opened_at": "2026-10-06T05:30:00.000Z", "last_opened_at": "2026-10-06T05:30:00.000Z", "last_device": "string", "created_at": "2026-10-06T05:30:00.000Z", "url": "string" }, "meta": {} }

{ "data": { "digest_enabled": true, "cadence": "weekly", "weekday": 1, "month_day": 1, "send_time": "string", "channel": "email", "link_days": 7, "sections": { "price": true, "views": true, "enquiries": true, "visits": true, "feedback": true, "offers": true, "matches": true, "activity": true }, "schedule_text": "string" }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/owner-reports/settings' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"digest_enabled":true,"cadence":"weekly","weekday":1,"month_day":1,"send_time":"string","channel":"email","link_days":7,"sections":{"price":true,"views":true,"enquiries":true,"visits":true,"feedback":true,"offers":true,"matches":true,"activity":true}}'

{ "data": { "property_id": "cmusrceel0000q7kaafxqi1om", "ref_code": "string", "title": "string", "status": "string", "reportable": true, "owner": { "present": true, "name": "string", "stopped": true, "owner_wide": true }, "settings": { "digest_opt_out": true, "opted_out_by": "string", "opted_out_at": "2026-10-06T05:30:00.000Z", "sections": { "price": true, "views": true, "enquiries": true, "visits": true, "feedback": true, "offers": true, "matches": true, "activity": true }, "overrides": { "price": true, "views": true, "enquiries": true, "visits": true, "feedback": true, "offers": true, "matches": true, "activity": true } }, "company": { "digest_enabled": true, "schedule": "string", "channel": "string", "sections": { "price": true, "views": true, "enquiries": true, "visits": true, "feedback": true, "offers": true, "matches": true, "activity": true } }, "links": [ { "id": "cmusrceel0000q7kaafxqi1om", "scope": "owner", "property_id": "cmusrceel0000q7kaafxqi1om", "listing": { "ref_code": "string", "title": "string" }, "state": "active", "issued_via": "string", "expires_at": "2026-10-06T05:30:00.000Z", "expires_text": "string", "renewed_at": "2026-10-06T05:30:00.000Z", "revoked_at": "2026-10-06T05:30:00.000Z", "revoke_reason": "string", "replaced_by_id": "cmusrceel0000q7kaafxqi1om", "open_count": 0, "first_opened_at": "2026-10-06T05:30:00.000Z", "last_opened_at": "2026-10-06T05:30:00.000Z", "last_device": "string", "created_at": "2026-10-06T05:30:00.000Z", "url": "string" } ], "entries": [ { "id": "cmusrceel0000q7kaafxqi1om", "property_id": "cmusrceel0000q7kaafxqi1om", "kind": "feedback", "action_kind": "open_house", "text": "string", "occurred_on": "2026-10-06", "status": "draft", "source": "string", "visit_item_id": "cmusrceel0000q7kaafxqi1om", "published_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z" } ], "visit_feedback": [ { "visit_item_id": "cmusrceel0000q7kaafxqi1om", "visited_on": "2026-10-06", "reaction": "string", "reasons": [ "string" ], "remarks": "string", "suggested_text": "string", "added": true } ], "sends": [ { "id": "cmusrceel0000q7kaafxqi1om", "kind": "string", "period_key": "string", "status": "string", "channel": "string", "blocked_reason": "string", "created_at": "2026-10-06T05:30:00.000Z" } ] }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/properties/{id}/owner-report' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"digest_opt_out":true,"sections":{"price":true,"views":true,"enquiries":true,"visits":true,"feedback":true,"offers":true,"matches":true,"activity":true}}'

curl -X POST 'https://api.propzolo.com/v1/properties/{id}/owner-report/entries' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"kind":"feedback","action_kind":"open_house","text":"string","occurred_on":"2026-10-06","status":"draft","visit_item_id":"cmusrceel0000q7kaafxqi1om"}'

{ "data": { "scope": "owner", "preview": true, "company": { "name": "string", "brand_color": "string", "logo_url": "string", "phone": "string" }, "owner_first_name": "string", "updated_text": "string", "expires_text": "string", "weeks": [ { "key": "string", "label": "string" } ], "listings": [ { "ref_code": "string", "title": "string", "place": "string", "rental": true, "status": "string", "status_label": "string", "listed_on": "string", "days_on_market": 0, "price": { "amount": 850000000, "per_month": true, "on_request": true, "history": [ { "on": null, "amount": null, "previous": null } ] }, "views": { "total": 0, "by_week": [ 0 ], "shared_with": 0, "shared_by_week": [ 0 ] }, "enquiries": { "total": 0, "by_week": [ 0 ], "sources": [ { "label": null, "count": null } ] }, "visits": { "done": 0, "upcoming": 0, "by_week": [ 0 ], "next": "string" }, "feedback": { "responses": 0, "liked": 0, "maybe": 0, "disliked": 0, "themes": [ { "key": null, "label": null, "count": null } ], "lines": [ { "on": null, "text": null } ] }, "offers": [ { "title": "string", "status": "string", "amount": 850000000, "per_month": true, "on": "string" } ], "matches": { "count": 0 }, "activity": [ { "on": "string", "label": "string", "text": "string" } ], "agent": { "name": "string", "designation": "string", "phone": "string", "photo_url": "string" } } ], "digest": { "on": true, "schedule": "string", "stopped": true } }, "meta": {} }