Inventory inbox

WhatsApp-group inventory (I-06): chat-export uploads, pastes and shares, the review queue of listings and requirements clustered across groups (freshness, demand, price history), decisions and read-only group capture.

GET/v1/inventory-inbox/capture

Read-only group capture on my linked phone: my groups and the ones I chose

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

Response · 200

datarequired: InventoryCapture
metarequired: object

Request

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

Response example

{
  "data": {
    "link": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "phone": "string"
    },
    "bridge": "ok",
    "groups": [
      {
        "jid": "string",
        "name": "string",
        "participants": 0,
        "announce": true,
        "selected": true,
        "consented_at": "2026-10-06T05:30:00.000Z",
        "messages_count": 0,
        "last_message_at": "2026-10-06T05:30:00.000Z",
        "left": true
      }
    ],
    "consent": {
      "version": "string",
      "text": "string",
      "hash": "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.

PUT/v1/inventory-inbox/capture

Choose the groups my linked phone captures (read-only; nothing is ever sent to a group)

Adding a group needs the consent notice’s `version` and `hash` as shown with GET.

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

Request body

link_idrequired: Id
Opaque record id.
groupsrequired: array of object
groups[].jidrequired: string
groups[].namerequired: string
consent: object or null
consent.versionrequired: string
consent.hashrequired: string

Response · 200

datarequired: InventoryCapture
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/inventory-inbox/capture' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"link_id":"cmusrceel0000q7kaafxqi1om","groups":[{"jid":"string","name":"string"}],"consent":{"version":"string","hash":"string"}}'

Response example

{
  "data": {
    "link": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "phone": "string"
    },
    "bridge": "ok",
    "groups": [
      {
        "jid": "string",
        "name": "string",
        "participants": 0,
        "announce": true,
        "selected": true,
        "consented_at": "2026-10-06T05:30:00.000Z",
        "messages_count": 0,
        "last_message_at": "2026-10-06T05:30:00.000Z",
        "left": true
      }
    ],
    "consent": {
      "version": "string",
      "text": "string",
      "hash": "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/inventory-inbox/clusters

The review queue: listings and requirements seen in WhatsApp groups, latest first

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

Parameters

statusquery: "pending" | "accepted" | "rejected" | "all"
kindquery: "listing" | "requirement"
readyquery: "true" | "false"
freshnessquery: "fresh" | "recent" | "aging" | "stale"
qquery: string
cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer

Response · 200

datarequired: array of InventoryCluster
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "listing",
      "status": "string",
      "title": "string",
      "transaction": "string",
      "property_type": "string",
      "bhk": 0,
      "area": {
        "value": 0,
        "unit": "string",
        "basis": "string",
        "sqft": 0
      },
      "price": 0,
      "price_min": 0,
      "rent": 0,
      "deposit": 0,
      "price_terms": [
        "string"
      ],
      "locality": "string",
      "project": "string",
      "city": "string",
      "floor": "string",
      "furnishing": "string",
      "possession": "string",
      "tenant_preference": "string",
      "co_broke_terms": "string",
      "amenities": [
        "string"
      ],
      "excerpt": "string",
      "contacts": [
        {
          "name": "string",
          "phone": "string",
          "masked": true
        }
      ],
      "confidence": 0,
      "review_fields": [
        "string"
      ],
      "flags": [
        "string"
      ],
      "missing": [
        "string"
      ],
      "bulk_ready": true,
      "freshness": {
        "score": 0,
        "label": "fresh"
      },
      "first_seen_at": "2026-10-06T05:30:00.000Z",
      "last_seen_at": "2026-10-06T05:30:00.000Z",
      "posts_count": 0,
      "groups_count": 0,
      "senders_count": 0,
      "group_names": [
        "string"
      ],
      "demand_count": 0,
      "price_change": {
        "from": 0,
        "to": 0
      },
      "duplicate": {
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "title": "string",
        "manual": true
      },
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "status": "string"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string"
      },
      "edits": {},
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "imported_by_me": true,
      "media_count": 0
    }
  ],
  "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/inventory-inbox/clusters/bulk-accept

Accept cards that are ready (every field ≥ 0.9, no flag, nothing missing, no look-alike), 25 at a time

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

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

ids: array of Id
Opaque record id.

Response · 200

datarequired: object
data.acceptedrequired: array of object
data.accepted[].idrequired: Id
Opaque record id.
data.accepted[].created_typerequired: "property" | "lead"
data.accepted[].created_idrequired: Id
Opaque record id.
data.accepted[].matchesrequired: integer
data.skippedrequired: array of object
data.skipped[].idrequired: Id
Opaque record id.
data.skipped[].reasonrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/inventory-inbox/clusters/bulk-accept' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": {
    "accepted": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "created_type": "property",
        "created_id": "cmusrceel0000q7kaafxqi1om",
        "matches": 0
      }
    ],
    "skipped": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "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.
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/inventory-inbox/clusters/{id}

One review card: the posts it was seen in, price history and fitting demand

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: InventoryClusterDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "listing",
    "status": "string",
    "title": "string",
    "transaction": "string",
    "property_type": "string",
    "bhk": 0,
    "area": {
      "value": 0,
      "unit": "string",
      "basis": "string",
      "sqft": 0
    },
    "price": 0,
    "price_min": 0,
    "rent": 0,
    "deposit": 0,
    "price_terms": [
      "string"
    ],
    "locality": "string",
    "project": "string",
    "city": "string",
    "floor": "string",
    "furnishing": "string",
    "possession": "string",
    "tenant_preference": "string",
    "co_broke_terms": "string",
    "amenities": [
      "string"
    ],
    "excerpt": "string",
    "contacts": [
      {
        "name": "string",
        "phone": "string",
        "masked": true
      }
    ],
    "confidence": 0,
    "review_fields": [
      "string"
    ],
    "flags": [
      "string"
    ],
    "missing": [
      "string"
    ],
    "bulk_ready": true,
    "freshness": {
      "score": 0,
      "label": "fresh"
    },
    "first_seen_at": "2026-10-06T05:30:00.000Z",
    "last_seen_at": "2026-10-06T05:30:00.000Z",
    "posts_count": 0,
    "groups_count": 0,
    "senders_count": 0,
    "group_names": [
      "string"
    ],
    "demand_count": 0,
    "price_change": {
      "from": 0,
      "to": 0
    },
    "duplicate": {
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string",
      "manual": true
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "status": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string"
    },
    "edits": {},
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decided_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "imported_by_me": true,
    "media_count": 0,
    "posts": [
      {
        "card_id": "cmusrceel0000q7kaafxqi1om",
        "post_id": "cmusrceel0000q7kaafxqi1om",
        "posted_at": "2026-10-06T05:30:00.000Z",
        "source": "string",
        "group_name": "string",
        "sender": {
          "name": "string",
          "phone": "string",
          "masked": true
        },
        "text": "string",
        "excerpt": "string",
        "amount": 0,
        "confidence": 0,
        "flags": [
          "string"
        ],
        "imported_by_me": true
      }
    ],
    "price_history": [
      {
        "at": "string",
        "amount": 0
      }
    ],
    "demand": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string",
        "last_seen_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/inventory-inbox/clusters/{id}

Correct a card’s fields before deciding (kept as a draft until accepted)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

kind: "listing" | "requirement"
transaction: "sale" | "rent" | "lease" | "pg"
property_type: string
bhk: number or null
area_value: number or null
area_unit: string or null
area_basis: "carpet" | "built_up" | "super_built_up" | "plot" | "unspecified" or null
price_rupees: integer or null
rent_rupees: integer or null
deposit_rupees: integer or null
locality: string or null
city: string or null
project: string or null
furnishing: "unfurnished" | "semi_furnished" | "fully_furnished" or null
contact_name: string or null
contact_phone: string or null

Response · 200

datarequired: InventoryClusterDetail
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/inventory-inbox/clusters/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"listing","transaction":"sale","property_type":"string","bhk":0,"area_value":0,"area_unit":"string","area_basis":"carpet","price_rupees":0,"rent_rupees":0,"deposit_rupees":0,"locality":"string","city":"string","project":"string","furnishing":"unfurnished","contact_name":"string","contact_phone":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "listing",
    "status": "string",
    "title": "string",
    "transaction": "string",
    "property_type": "string",
    "bhk": 0,
    "area": {
      "value": 0,
      "unit": "string",
      "basis": "string",
      "sqft": 0
    },
    "price": 0,
    "price_min": 0,
    "rent": 0,
    "deposit": 0,
    "price_terms": [
      "string"
    ],
    "locality": "string",
    "project": "string",
    "city": "string",
    "floor": "string",
    "furnishing": "string",
    "possession": "string",
    "tenant_preference": "string",
    "co_broke_terms": "string",
    "amenities": [
      "string"
    ],
    "excerpt": "string",
    "contacts": [
      {
        "name": "string",
        "phone": "string",
        "masked": true
      }
    ],
    "confidence": 0,
    "review_fields": [
      "string"
    ],
    "flags": [
      "string"
    ],
    "missing": [
      "string"
    ],
    "bulk_ready": true,
    "freshness": {
      "score": 0,
      "label": "fresh"
    },
    "first_seen_at": "2026-10-06T05:30:00.000Z",
    "last_seen_at": "2026-10-06T05:30:00.000Z",
    "posts_count": 0,
    "groups_count": 0,
    "senders_count": 0,
    "group_names": [
      "string"
    ],
    "demand_count": 0,
    "price_change": {
      "from": 0,
      "to": 0
    },
    "duplicate": {
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string",
      "manual": true
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "status": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string"
    },
    "edits": {},
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decided_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "imported_by_me": true,
    "media_count": 0,
    "posts": [
      {
        "card_id": "cmusrceel0000q7kaafxqi1om",
        "post_id": "cmusrceel0000q7kaafxqi1om",
        "posted_at": "2026-10-06T05:30:00.000Z",
        "source": "string",
        "group_name": "string",
        "sender": {
          "name": "string",
          "phone": "string",
          "masked": true
        },
        "text": "string",
        "excerpt": "string",
        "amount": 0,
        "confidence": 0,
        "flags": [
          "string"
        ],
        "imported_by_me": true
      }
    ],
    "price_history": [
      {
        "at": "string",
        "amount": 0
      }
    ],
    "demand": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string",
        "last_seen_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/inventory-inbox/clusters/{id}/accept

Accept a card: a private listing or a lead; matching runs at once

A card that looks like an existing listing answers 409 until `duplicate` says `link` (no new listing) or `create`. Requirements can be accepted only by a member who imported one of their posts (the number is private to them).

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

Parameters

idpathrequired: Id
Opaque record id.
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

edits: InventoryCardEdits
duplicate: "link" | "create"

Response · 200

datarequired: object
data.clusterrequired: InventoryClusterDetail
data.createdrequired: object or null
data.created.typerequired: "property" | "lead"
data.created.idrequired: Id
Opaque record id.
data.created.refrequired: string or null
data.created.statusrequired: string or null
data.matchesrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/inventory-inbox/clusters/{id}/accept' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"edits":{"kind":"listing","transaction":"sale","property_type":"string","bhk":0,"area_value":0,"area_unit":"string","area_basis":"carpet","price_rupees":0,"rent_rupees":0,"deposit_rupees":0,"locality":"string","city":"string","project":"string","furnishing":"unfurnished","contact_name":"string","contact_phone":"string"},"duplicate":"link"}'

Response example

{
  "data": {
    "cluster": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "listing",
      "status": "string",
      "title": "string",
      "transaction": "string",
      "property_type": "string",
      "bhk": 0,
      "area": {
        "value": 0,
        "unit": "string",
        "basis": "string",
        "sqft": 0
      },
      "price": 0,
      "price_min": 0,
      "rent": 0,
      "deposit": 0,
      "price_terms": [
        "string"
      ],
      "locality": "string",
      "project": "string",
      "city": "string",
      "floor": "string",
      "furnishing": "string",
      "possession": "string",
      "tenant_preference": "string",
      "co_broke_terms": "string",
      "amenities": [
        "string"
      ],
      "excerpt": "string",
      "contacts": [
        {
          "name": "string",
          "phone": "string",
          "masked": true
        }
      ],
      "confidence": 0,
      "review_fields": [
        "string"
      ],
      "flags": [
        "string"
      ],
      "missing": [
        "string"
      ],
      "bulk_ready": true,
      "freshness": {
        "score": 0,
        "label": "fresh"
      },
      "first_seen_at": "2026-10-06T05:30:00.000Z",
      "last_seen_at": "2026-10-06T05:30:00.000Z",
      "posts_count": 0,
      "groups_count": 0,
      "senders_count": 0,
      "group_names": [
        "string"
      ],
      "demand_count": 0,
      "price_change": {
        "from": 0,
        "to": 0
      },
      "duplicate": {
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "title": "string",
        "manual": true
      },
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "status": "string"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string"
      },
      "edits": {},
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "imported_by_me": true,
      "media_count": 0,
      "posts": [
        {
          "card_id": "cmusrceel0000q7kaafxqi1om",
          "post_id": "cmusrceel0000q7kaafxqi1om",
          "posted_at": "2026-10-06T05:30:00.000Z",
          "source": "string",
          "group_name": "string",
          "sender": {
            "name": "string",
            "phone": "string",
            "masked": true
          },
          "text": "string",
          "excerpt": "string",
          "amount": 0,
          "confidence": 0,
          "flags": [
            "string"
          ],
          "imported_by_me": true
        }
      ],
      "price_history": [
        {
          "at": "string",
          "amount": 0
        }
      ],
      "demand": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "title": "string",
          "last_seen_at": "2026-10-06T05:30:00.000Z"
        }
      ]
    },
    "created": {
      "type": "property",
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "status": "string"
    },
    "matches": 0
  },
  "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.

PUT/v1/inventory-inbox/clusters/{id}/duplicate

Say which listing this card is (or that it is not a duplicate)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

property_idrequired: Id or null
Opaque record id.

Response · 200

datarequired: InventoryClusterDetail
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/inventory-inbox/clusters/{id}/duplicate' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"property_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "listing",
    "status": "string",
    "title": "string",
    "transaction": "string",
    "property_type": "string",
    "bhk": 0,
    "area": {
      "value": 0,
      "unit": "string",
      "basis": "string",
      "sqft": 0
    },
    "price": 0,
    "price_min": 0,
    "rent": 0,
    "deposit": 0,
    "price_terms": [
      "string"
    ],
    "locality": "string",
    "project": "string",
    "city": "string",
    "floor": "string",
    "furnishing": "string",
    "possession": "string",
    "tenant_preference": "string",
    "co_broke_terms": "string",
    "amenities": [
      "string"
    ],
    "excerpt": "string",
    "contacts": [
      {
        "name": "string",
        "phone": "string",
        "masked": true
      }
    ],
    "confidence": 0,
    "review_fields": [
      "string"
    ],
    "flags": [
      "string"
    ],
    "missing": [
      "string"
    ],
    "bulk_ready": true,
    "freshness": {
      "score": 0,
      "label": "fresh"
    },
    "first_seen_at": "2026-10-06T05:30:00.000Z",
    "last_seen_at": "2026-10-06T05:30:00.000Z",
    "posts_count": 0,
    "groups_count": 0,
    "senders_count": 0,
    "group_names": [
      "string"
    ],
    "demand_count": 0,
    "price_change": {
      "from": 0,
      "to": 0
    },
    "duplicate": {
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string",
      "manual": true
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "status": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string"
    },
    "edits": {},
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decided_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "imported_by_me": true,
    "media_count": 0,
    "posts": [
      {
        "card_id": "cmusrceel0000q7kaafxqi1om",
        "post_id": "cmusrceel0000q7kaafxqi1om",
        "posted_at": "2026-10-06T05:30:00.000Z",
        "source": "string",
        "group_name": "string",
        "sender": {
          "name": "string",
          "phone": "string",
          "masked": true
        },
        "text": "string",
        "excerpt": "string",
        "amount": 0,
        "confidence": 0,
        "flags": [
          "string"
        ],
        "imported_by_me": true
      }
    ],
    "price_history": [
      {
        "at": "string",
        "amount": 0
      }
    ],
    "demand": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string",
        "last_seen_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/inventory-inbox/clusters/{id}/merge

Merge other cards into this one (the same listing)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

cluster_idsrequired: array of Id
Opaque record id.

Response · 200

datarequired: InventoryClusterDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/inventory-inbox/clusters/{id}/merge' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"cluster_ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "listing",
    "status": "string",
    "title": "string",
    "transaction": "string",
    "property_type": "string",
    "bhk": 0,
    "area": {
      "value": 0,
      "unit": "string",
      "basis": "string",
      "sqft": 0
    },
    "price": 0,
    "price_min": 0,
    "rent": 0,
    "deposit": 0,
    "price_terms": [
      "string"
    ],
    "locality": "string",
    "project": "string",
    "city": "string",
    "floor": "string",
    "furnishing": "string",
    "possession": "string",
    "tenant_preference": "string",
    "co_broke_terms": "string",
    "amenities": [
      "string"
    ],
    "excerpt": "string",
    "contacts": [
      {
        "name": "string",
        "phone": "string",
        "masked": true
      }
    ],
    "confidence": 0,
    "review_fields": [
      "string"
    ],
    "flags": [
      "string"
    ],
    "missing": [
      "string"
    ],
    "bulk_ready": true,
    "freshness": {
      "score": 0,
      "label": "fresh"
    },
    "first_seen_at": "2026-10-06T05:30:00.000Z",
    "last_seen_at": "2026-10-06T05:30:00.000Z",
    "posts_count": 0,
    "groups_count": 0,
    "senders_count": 0,
    "group_names": [
      "string"
    ],
    "demand_count": 0,
    "price_change": {
      "from": 0,
      "to": 0
    },
    "duplicate": {
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string",
      "manual": true
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "status": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string"
    },
    "edits": {},
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decided_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "imported_by_me": true,
    "media_count": 0,
    "posts": [
      {
        "card_id": "cmusrceel0000q7kaafxqi1om",
        "post_id": "cmusrceel0000q7kaafxqi1om",
        "posted_at": "2026-10-06T05:30:00.000Z",
        "source": "string",
        "group_name": "string",
        "sender": {
          "name": "string",
          "phone": "string",
          "masked": true
        },
        "text": "string",
        "excerpt": "string",
        "amount": 0,
        "confidence": 0,
        "flags": [
          "string"
        ],
        "imported_by_me": true
      }
    ],
    "price_history": [
      {
        "at": "string",
        "amount": 0
      }
    ],
    "demand": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string",
        "last_seen_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/inventory-inbox/clusters/{id}/reject

Reject a card (noise teaches the parser)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: "noise" | "sold" | "not_relevant" | "duplicate"

Response · 200

datarequired: InventoryClusterDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/inventory-inbox/clusters/{id}/reject' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"noise"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "listing",
    "status": "string",
    "title": "string",
    "transaction": "string",
    "property_type": "string",
    "bhk": 0,
    "area": {
      "value": 0,
      "unit": "string",
      "basis": "string",
      "sqft": 0
    },
    "price": 0,
    "price_min": 0,
    "rent": 0,
    "deposit": 0,
    "price_terms": [
      "string"
    ],
    "locality": "string",
    "project": "string",
    "city": "string",
    "floor": "string",
    "furnishing": "string",
    "possession": "string",
    "tenant_preference": "string",
    "co_broke_terms": "string",
    "amenities": [
      "string"
    ],
    "excerpt": "string",
    "contacts": [
      {
        "name": "string",
        "phone": "string",
        "masked": true
      }
    ],
    "confidence": 0,
    "review_fields": [
      "string"
    ],
    "flags": [
      "string"
    ],
    "missing": [
      "string"
    ],
    "bulk_ready": true,
    "freshness": {
      "score": 0,
      "label": "fresh"
    },
    "first_seen_at": "2026-10-06T05:30:00.000Z",
    "last_seen_at": "2026-10-06T05:30:00.000Z",
    "posts_count": 0,
    "groups_count": 0,
    "senders_count": 0,
    "group_names": [
      "string"
    ],
    "demand_count": 0,
    "price_change": {
      "from": 0,
      "to": 0
    },
    "duplicate": {
      "property_id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string",
      "manual": true
    },
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "status": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string"
    },
    "edits": {},
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decided_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "imported_by_me": true,
    "media_count": 0,
    "posts": [
      {
        "card_id": "cmusrceel0000q7kaafxqi1om",
        "post_id": "cmusrceel0000q7kaafxqi1om",
        "posted_at": "2026-10-06T05:30:00.000Z",
        "source": "string",
        "group_name": "string",
        "sender": {
          "name": "string",
          "phone": "string",
          "masked": true
        },
        "text": "string",
        "excerpt": "string",
        "amount": 0,
        "confidence": 0,
        "flags": [
          "string"
        ],
        "imported_by_me": true
      }
    ],
    "price_history": [
      {
        "at": "string",
        "amount": 0
      }
    ],
    "demand": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string",
        "last_seen_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/inventory-inbox/clusters/{id}/split

Split posts off a card (they are another listing)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

card_idsrequired: array of Id
Opaque record id.

Response · 200

datarequired: object
data.clusterrequired: InventoryClusterDetail
data.createdrequired: InventoryClusterDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/inventory-inbox/clusters/{id}/split' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"card_ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": {
    "cluster": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "listing",
      "status": "string",
      "title": "string",
      "transaction": "string",
      "property_type": "string",
      "bhk": 0,
      "area": {
        "value": 0,
        "unit": "string",
        "basis": "string",
        "sqft": 0
      },
      "price": 0,
      "price_min": 0,
      "rent": 0,
      "deposit": 0,
      "price_terms": [
        "string"
      ],
      "locality": "string",
      "project": "string",
      "city": "string",
      "floor": "string",
      "furnishing": "string",
      "possession": "string",
      "tenant_preference": "string",
      "co_broke_terms": "string",
      "amenities": [
        "string"
      ],
      "excerpt": "string",
      "contacts": [
        {
          "name": "string",
          "phone": "string",
          "masked": true
        }
      ],
      "confidence": 0,
      "review_fields": [
        "string"
      ],
      "flags": [
        "string"
      ],
      "missing": [
        "string"
      ],
      "bulk_ready": true,
      "freshness": {
        "score": 0,
        "label": "fresh"
      },
      "first_seen_at": "2026-10-06T05:30:00.000Z",
      "last_seen_at": "2026-10-06T05:30:00.000Z",
      "posts_count": 0,
      "groups_count": 0,
      "senders_count": 0,
      "group_names": [
        "string"
      ],
      "demand_count": 0,
      "price_change": {
        "from": 0,
        "to": 0
      },
      "duplicate": {
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "title": "string",
        "manual": true
      },
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "status": "string"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string"
      },
      "edits": {},
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "imported_by_me": true,
      "media_count": 0,
      "posts": [
        {
          "card_id": "cmusrceel0000q7kaafxqi1om",
          "post_id": "cmusrceel0000q7kaafxqi1om",
          "posted_at": "2026-10-06T05:30:00.000Z",
          "source": "string",
          "group_name": "string",
          "sender": {
            "name": "string",
            "phone": "string",
            "masked": true
          },
          "text": "string",
          "excerpt": "string",
          "amount": 0,
          "confidence": 0,
          "flags": [
            "string"
          ],
          "imported_by_me": true
        }
      ],
      "price_history": [
        {
          "at": "string",
          "amount": 0
        }
      ],
      "demand": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "title": "string",
          "last_seen_at": "2026-10-06T05:30:00.000Z"
        }
      ]
    },
    "created": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "listing",
      "status": "string",
      "title": "string",
      "transaction": "string",
      "property_type": "string",
      "bhk": 0,
      "area": {
        "value": 0,
        "unit": "string",
        "basis": "string",
        "sqft": 0
      },
      "price": 0,
      "price_min": 0,
      "rent": 0,
      "deposit": 0,
      "price_terms": [
        "string"
      ],
      "locality": "string",
      "project": "string",
      "city": "string",
      "floor": "string",
      "furnishing": "string",
      "possession": "string",
      "tenant_preference": "string",
      "co_broke_terms": "string",
      "amenities": [
        "string"
      ],
      "excerpt": "string",
      "contacts": [
        {
          "name": "string",
          "phone": "string",
          "masked": true
        }
      ],
      "confidence": 0,
      "review_fields": [
        "string"
      ],
      "flags": [
        "string"
      ],
      "missing": [
        "string"
      ],
      "bulk_ready": true,
      "freshness": {
        "score": 0,
        "label": "fresh"
      },
      "first_seen_at": "2026-10-06T05:30:00.000Z",
      "last_seen_at": "2026-10-06T05:30:00.000Z",
      "posts_count": 0,
      "groups_count": 0,
      "senders_count": 0,
      "group_names": [
        "string"
      ],
      "demand_count": 0,
      "price_change": {
        "from": 0,
        "to": 0
      },
      "duplicate": {
        "property_id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "title": "string",
        "manual": true
      },
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "status": "string"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string"
      },
      "edits": {},
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "imported_by_me": true,
      "media_count": 0,
      "posts": [
        {
          "card_id": "cmusrceel0000q7kaafxqi1om",
          "post_id": "cmusrceel0000q7kaafxqi1om",
          "posted_at": "2026-10-06T05:30:00.000Z",
          "source": "string",
          "group_name": "string",
          "sender": {
            "name": "string",
            "phone": "string",
            "masked": true
          },
          "text": "string",
          "excerpt": "string",
          "amount": 0,
          "confidence": 0,
          "flags": [
            "string"
          ],
          "imported_by_me": true
        }
      ],
      "price_history": [
        {
          "at": "string",
          "amount": 0
        }
      ],
      "demand": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "title": "string",
          "last_seen_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/inventory-inbox/ingests

Imports into the inventory inbox, newest first

Members see their own imports; members who manage AI settings see everyone’s.

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

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer

Response · 200

datarequired: array of InventoryIngest
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "channel": "chat_export",
      "status": "uploading",
      "group_name": "string",
      "file_name": "string",
      "file_size": 0,
      "platform": "string",
      "messages": {
        "total": 0,
        "new": 0,
        "duplicate": 0,
        "skipped": 0
      },
      "progress": {
        "queued": 0,
        "parsing": 0,
        "parsed": 0,
        "noise": 0,
        "failed": 0,
        "skipped": 0,
        "cards": 0
      },
      "error": "string",
      "member": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "cancellable": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "started_at": "2026-10-06T05:30:00.000Z",
      "finished_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/inventory-inbox/ingests

Import a WhatsApp chat export or paste broker posts

multipart/form-data with `file` (the .txt or .zip of WhatsApp “Export chat”, ≤ 10 MB) and optional `group_name` starts reading at once; JSON `{ kind: "upload", file_name, size }` returns a presigned PUT (≤ 80 MB) — then POST …/start; JSON `{ kind: "paste", text }` stores the post (or lines copied from an export) for the parser.

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

Response · 201

datarequired: object
data.ingestrequired: InventoryIngest
data.uploadrequired: object or null
data.upload.urlrequired: string
data.upload.methodrequired: "PUT"
data.upload.headersrequired: map of string
data.upload.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/inventory-inbox/ingests' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "ingest": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "channel": "chat_export",
      "status": "uploading",
      "group_name": "string",
      "file_name": "string",
      "file_size": 0,
      "platform": "string",
      "messages": {
        "total": 0,
        "new": 0,
        "duplicate": 0,
        "skipped": 0
      },
      "progress": {
        "queued": 0,
        "parsing": 0,
        "parsed": 0,
        "noise": 0,
        "failed": 0,
        "skipped": 0,
        "cards": 0
      },
      "error": "string",
      "member": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "cancellable": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "started_at": "2026-10-06T05:30:00.000Z",
      "finished_at": "2026-10-06T05:30:00.000Z"
    },
    "upload": {
      "url": "string",
      "method": "PUT",
      "headers": {},
      "expires_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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/inventory-inbox/ingests/{id}

An import and its progress

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: InventoryIngest
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "chat_export",
    "status": "uploading",
    "group_name": "string",
    "file_name": "string",
    "file_size": 0,
    "platform": "string",
    "messages": {
      "total": 0,
      "new": 0,
      "duplicate": 0,
      "skipped": 0
    },
    "progress": {
      "queued": 0,
      "parsing": 0,
      "parsed": 0,
      "noise": 0,
      "failed": 0,
      "skipped": 0,
      "cards": 0
    },
    "error": "string",
    "member": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "cancellable": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "started_at": "2026-10-06T05:30:00.000Z",
    "finished_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/inventory-inbox/ingests/{id}/cancel

Stop an import (posts not read yet are never sent to the AI)

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: InventoryIngest
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/inventory-inbox/ingests/{id}/cancel' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "chat_export",
    "status": "uploading",
    "group_name": "string",
    "file_name": "string",
    "file_size": 0,
    "platform": "string",
    "messages": {
      "total": 0,
      "new": 0,
      "duplicate": 0,
      "skipped": 0
    },
    "progress": {
      "queued": 0,
      "parsing": 0,
      "parsed": 0,
      "noise": 0,
      "failed": 0,
      "skipped": 0,
      "cards": 0
    },
    "error": "string",
    "member": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "cancellable": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "started_at": "2026-10-06T05:30:00.000Z",
    "finished_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/inventory-inbox/ingests/{id}/start

Start reading an export uploaded with a presigned PUT

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: InventoryIngest
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/inventory-inbox/ingests/{id}/start' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "chat_export",
    "status": "uploading",
    "group_name": "string",
    "file_name": "string",
    "file_size": 0,
    "platform": "string",
    "messages": {
      "total": 0,
      "new": 0,
      "duplicate": 0,
      "skipped": 0
    },
    "progress": {
      "queued": 0,
      "parsing": 0,
      "parsed": 0,
      "noise": 0,
      "failed": 0,
      "skipped": 0,
      "cards": 0
    },
    "error": "string",
    "member": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "cancellable": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "started_at": "2026-10-06T05:30:00.000Z",
    "finished_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.

GET/v1/inventory-inbox/settings

Inventory inbox settings: forwards to the company number, how far back exports are read

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

Response · 200

datarequired: InventoryInboxSettings
metarequired: object

Request

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

Response example

{
  "data": {
    "forwards": true,
    "export_since_days": 1
  },
  "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/inventory-inbox/settings

Change the inventory inbox settings

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

Request body

forwards: boolean
export_since_days: integer

Response · 200

datarequired: InventoryInboxSettings
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/inventory-inbox/settings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"forwards":true,"export_since_days":1}'

Response example

{
  "data": {
    "forwards": true,
    "export_since_days": 1
  },
  "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/inventory-inbox/share

Android share target: a post shared from WhatsApp into the inbox

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

Request body

textrequired: string
group_name: string or null
sender: object or null
sender.name: string or null
sender.phone: string or null

Response · 201

datarequired: InventoryIngest
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/inventory-inbox/share' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"text":"string","group_name":"string","sender":{"name":"string","phone":"string"}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "channel": "chat_export",
    "status": "uploading",
    "group_name": "string",
    "file_name": "string",
    "file_size": 0,
    "platform": "string",
    "messages": {
      "total": 0,
      "new": 0,
      "duplicate": 0,
      "skipped": 0
    },
    "progress": {
      "queued": 0,
      "parsing": 0,
      "parsed": 0,
      "noise": 0,
      "failed": 0,
      "skipped": 0,
      "cards": 0
    },
    "error": "string",
    "member": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "cancellable": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "started_at": "2026-10-06T05:30:00.000Z",
    "finished_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/inventory-inbox/summary

Counts for the queue: waiting for review, ready to bulk-accept, posts still being read

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

Response · 200

datarequired: object
data.pendingrequired: integer
data.readyrequired: integer
data.parsingrequired: integer
metarequired: object

Request

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

Response example

{
  "data": {
    "pending": 0,
    "ready": 0,
    "parsing": 0
  },
  "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.