Shares — PropZolo API

← All areas

Tracked share links with views, reactions and hot signals.

GET/v1/shares

Share links

Newest first, for a lead or a listing (or the caller’s own); with view counts and reactions.

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

Parameters

lead_idquery: Id
Opaque record id.
property_idquery: Id
Opaque record id.
limitquery: integer

Response · 200

datarequired: array of Share
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "url": "string",
      "title": "string",
      "channel": "string",
      "status": "active",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "property_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "shared_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "view_count": 0,
      "view_seconds": 0,
      "first_viewed_at": "2026-10-06T05:30:00.000Z",
      "last_viewed_at": "2026-10-06T05:30:00.000Z",
      "reactions": {},
      "expires_at": "2026-10-06T05:30:00.000Z",
      "revoked_at": "2026-10-06T05:30:00.000Z",
      "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.
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/shares

Create a tracked share link

A shortlist of up to 20 listings, or a project, for a lead. Returns the link, a ready message and a wa.me draft. The listings must be visible to the caller; the lead must be one the caller can see.

Access: API key or member session. Permission properties.share.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

lead_id: Id or null
Opaque record id.
property_ids: array of Id
Opaque record id.
project_id: Id or null
Opaque record id.
channel: ShareChannel
copy (link copied) · wa_link (wa.me draft on the agent’s phone) · the others are recorded for the messaging pipeline.
expires_in_days: integer
Default 30 days.
message: string or null
Intro line for the WhatsApp draft.

Response · 201

datarequired: CreatedShare
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/shares' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_id":"cmusrceel0000q7kaafxqi1om","property_ids":[],"project_id":"cmusrceel0000q7kaafxqi1om","channel":"copy","expires_in_days":1,"message":"string"}'

Response example

{
  "data": {
    "share": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "url": "string",
      "title": "string",
      "channel": "string",
      "status": "active",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "property_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "project_id": "cmusrceel0000q7kaafxqi1om",
      "shared_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "view_count": 0,
      "view_seconds": 0,
      "first_viewed_at": "2026-10-06T05:30:00.000Z",
      "last_viewed_at": "2026-10-06T05:30:00.000Z",
      "reactions": {},
      "expires_at": "2026-10-06T05:30:00.000Z",
      "revoked_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z"
    },
    "message_text": "string",
    "whatsapp_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.

GET/v1/shares/recipients

Leads to share with

Open buyer / tenant leads the caller can see, by name, phone digits or L- reference.

Access: API key or member session. Permission properties.share.

Parameters

qqueryrequired: string
limitquery: integer

Response · 200

datarequired: array of ShareRecipient
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string",
      "lead_type": "buy"
    }
  ],
  "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.
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/shares/{id}

A share link with its views

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.urlrequired: string
data.titlerequired: string
data.channelrequired: string
data.statusrequired: "active" | "expired" | "revoked"
data.leadrequired: object or null
data.lead.idrequired: Id
Opaque record id.
data.lead.refrequired: string
data.lead.namerequired: string
data.property_idsrequired: array of Id
Opaque record id.
data.project_idrequired: Id or null
Opaque record id.
data.shared_byrequired: MemberRef or null
data.view_countrequired: integer
data.view_secondsrequired: integer
data.first_viewed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.last_viewed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.reactionsrequired: map of ShareReaction
data.expires_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.revoked_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.viewsrequired: array of ShareView
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "url": "string",
    "title": "string",
    "channel": "string",
    "status": "active",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "property_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "shared_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "view_count": 0,
    "view_seconds": 0,
    "first_viewed_at": "2026-10-06T05:30:00.000Z",
    "last_viewed_at": "2026-10-06T05:30:00.000Z",
    "reactions": {},
    "expires_at": "2026-10-06T05:30:00.000Z",
    "revoked_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "views": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "seconds": 0,
        "device": "string",
        "city": "string",
        "viewed_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/shares/{id}/revoke

Revoke a share link

The page stops rendering at once (410 Gone). The author, or anyone who may edit the lead, can revoke.

Access: API key or member session. Permission properties.share.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: Share
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "url": "string",
    "title": "string",
    "channel": "string",
    "status": "active",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "property_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "project_id": "cmusrceel0000q7kaafxqi1om",
    "shared_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "view_count": 0,
    "view_seconds": 0,
    "first_viewed_at": "2026-10-06T05:30:00.000Z",
    "last_viewed_at": "2026-10-06T05:30:00.000Z",
    "reactions": {},
    "expires_at": "2026-10-06T05:30:00.000Z",
    "revoked_at": "2026-10-06T05:30:00.000Z",
    "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.

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "url": "string", "title": "string", "channel": "string", "status": "active", "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "property_ids": [ "cmusrceel0000q7kaafxqi1om" ], "project_id": "cmusrceel0000q7kaafxqi1om", "shared_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "view_count": 0, "view_seconds": 0, "first_viewed_at": "2026-10-06T05:30:00.000Z", "last_viewed_at": "2026-10-06T05:30:00.000Z", "reactions": {}, "expires_at": "2026-10-06T05:30:00.000Z", "revoked_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z" } ], "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/shares' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"lead_id":"cmusrceel0000q7kaafxqi1om","property_ids":[],"project_id":"cmusrceel0000q7kaafxqi1om","channel":"copy","expires_in_days":1,"message":"string"}'

{ "data": { "share": { "id": "cmusrceel0000q7kaafxqi1om", "url": "string", "title": "string", "channel": "string", "status": "active", "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "property_ids": [ "cmusrceel0000q7kaafxqi1om" ], "project_id": "cmusrceel0000q7kaafxqi1om", "shared_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "view_count": 0, "view_seconds": 0, "first_viewed_at": "2026-10-06T05:30:00.000Z", "last_viewed_at": "2026-10-06T05:30:00.000Z", "reactions": {}, "expires_at": "2026-10-06T05:30:00.000Z", "revoked_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z" }, "message_text": "string", "whatsapp_url": "string" }, "meta": {} }

GET/v1/shares/recipients

Leads to share with

Open buyer / tenant leads the caller can see, by name, phone digits or L- reference.

Access: API key or member session. Permission properties.share.

Parameters

qqueryrequired: string
limitquery: integer

Response · 200

datarequired: array of ShareRecipient
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string",
      "lead_type": "buy"
    }
  ],
  "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.
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", "url": "string", "title": "string", "channel": "string", "status": "active", "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "property_ids": [ "cmusrceel0000q7kaafxqi1om" ], "project_id": "cmusrceel0000q7kaafxqi1om", "shared_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "view_count": 0, "view_seconds": 0, "first_viewed_at": "2026-10-06T05:30:00.000Z", "last_viewed_at": "2026-10-06T05:30:00.000Z", "reactions": {}, "expires_at": "2026-10-06T05:30:00.000Z", "revoked_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "views": [ { "id": "cmusrceel0000q7kaafxqi1om", "property_id": "cmusrceel0000q7kaafxqi1om", "seconds": 0, "device": "string", "city": "string", "viewed_at": "2026-10-06T05:30:00.000Z" } ] }, "meta": {} }