AI

Copilot drafts and summaries, explain-this-lead, lead score, requirement proposals, listing copy, plain-words search and the inventory inbox — validated, metered on the AI wallet and audited.

POST/v1/ai/ask

Ask PropZolo: a question in plain words → a validated query, the result and a grounded answer

The model sees the caller’s field catalogue only (no records) and returns a plan in the query language; the server validates it against the caller’s whitelist and field rules, runs it with their view scope, and the model writes the answer from the result alone (an unsourced figure replaces it with the server’s own answer).

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

Request body

questionrequired: string
previous_id: Id or null
The previous question, for follow-ups.

Response · 200

datarequired: AskAnswer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/ask' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"question":"string","previous_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "answered",
    "explanation": "string",
    "clarifying_question": "string",
    "reason": "string",
    "plan": {
      "kind": "query",
      "query": {
        "entity": "string",
        "filter": null,
        "range": {
          "field": "string",
          "preset": "today",
          "from": "string",
          "to": "string"
        },
        "measures": [
          {
            "fn": null,
            "field": null
          }
        ],
        "group_by": {
          "field": "string",
          "bucket": "day"
        },
        "sort": {
          "by": "value",
          "field": "string",
          "dir": "asc"
        },
        "limit": 1
      }
    },
    "description": "string",
    "result": {
      "mode": "list",
      "entity": "string",
      "title": "string",
      "columns": [
        {
          "key": "string",
          "label": "string",
          "kind": "text"
        }
      ],
      "rows": [
        {
          "key": "string",
          "label": "string",
          "name": "string",
          "cells": {},
          "link": "string",
          "filter": null
        }
      ],
      "totals": {},
      "matched": 0,
      "truncated": true,
      "range": {
        "label": "string",
        "from_day": "string",
        "to_day": "string"
      },
      "notes": [
        "string"
      ]
    },
    "labels": {},
    "answer": {
      "text": "string",
      "source": "ai",
      "citations": [
        "string"
      ],
      "follow_ups": [
        "string"
      ]
    },
    "findings": [
      {
        "validator": "grounding",
        "code": "string",
        "severity": "info",
        "message": "string",
        "path": "string",
        "match": "string",
        "action": "flagged"
      }
    ],
    "blocked": true,
    "credits": 0,
    "request_id": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

GET/v1/ai/ask/catalogue

What the caller can ask about: entities, fields (with options) and reports, for the manual builder

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

Response · 200

datarequired: AskCatalogue
metarequired: object

Request

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

Response example

{
  "data": {
    "entities": [
      {
        "key": "string",
        "label": "string",
        "noun": [],
        "default_date": "string",
        "fields": [
          {
            "key": "string",
            "label": "string",
            "type": "string",
            "of": "string",
            "options": [
              null
            ],
            "money": true,
            "nullable": true,
            "section": "string",
            "group": true,
            "measure": true,
            "range": true
          }
        ]
      }
    ],
    "reports": [
      {
        "key": "source_costs",
        "label": "string",
        "description": "string"
      }
    ],
    "presets": [
      {
        "key": "today",
        "label": "string"
      }
    ],
    "examples": [
      "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.

GET/v1/ai/ask/history

The caller’s questions, newest first

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

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.

Response · 200

datarequired: array of AskQuestion
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "question": "string",
      "status": "answered",
      "plan": {
        "kind": "query",
        "query": {
          "entity": "string",
          "filter": null,
          "range": {
            "field": null,
            "preset": null,
            "from": null,
            "to": null
          },
          "measures": [
            null
          ],
          "group_by": {
            "field": null,
            "bucket": null
          },
          "sort": {
            "by": null,
            "field": null,
            "dir": null
          },
          "limit": 1
        }
      },
      "answer": "string",
      "answer_source": "string",
      "citations": [
        "string"
      ],
      "follow_ups": [
        "string"
      ],
      "summary": {
        "entity": "string",
        "mode": "string",
        "title": "string",
        "matched": 0
      },
      "credits": 0,
      "created_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.

GET/v1/ai/ask/history/{id}

One of the caller’s questions, its result run again now

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.questionrequired: string
data.statusrequired: "answered" | "clarify" | "cannot_answer" | "invalid" | "failed"
data.planrequired: AskPlan or null
An Ask PropZolo query, or a named report with its period.
data.answerrequired: string or null
data.answer_sourcerequired: string or null
data.citationsrequired: array of string
data.follow_upsrequired: array of string
data.summaryrequired: object or null
data.summary.entityrequired: string
data.summary.moderequired: string
data.summary.titlerequired: string
data.summary.matchedrequired: number
data.creditsrequired: integer
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.resultrequired: AskResult or null
data.labelsrequired: map of map of string
Value labels the catalogue cannot give the chips (locality id → name).
data.errorrequired: string or null
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "question": "string",
    "status": "answered",
    "plan": {
      "kind": "query",
      "query": {
        "entity": "string",
        "filter": null,
        "range": {
          "field": "string",
          "preset": "today",
          "from": "string",
          "to": "string"
        },
        "measures": [
          {
            "fn": null,
            "field": null
          }
        ],
        "group_by": {
          "field": "string",
          "bucket": "day"
        },
        "sort": {
          "by": "value",
          "field": "string",
          "dir": "asc"
        },
        "limit": 1
      }
    },
    "answer": "string",
    "answer_source": "string",
    "citations": [
      "string"
    ],
    "follow_ups": [
      "string"
    ],
    "summary": {
      "entity": "string",
      "mode": "string",
      "title": "string",
      "matched": 0
    },
    "credits": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "result": {
      "mode": "list",
      "entity": "string",
      "title": "string",
      "columns": [
        {
          "key": "string",
          "label": "string",
          "kind": "text"
        }
      ],
      "rows": [
        {
          "key": "string",
          "label": "string",
          "name": "string",
          "cells": {},
          "link": "string",
          "filter": null
        }
      ],
      "totals": {},
      "matched": 0,
      "truncated": true,
      "range": {
        "label": "string",
        "from_day": "string",
        "to_day": "string"
      },
      "notes": [
        "string"
      ]
    },
    "labels": {},
    "error": "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/ai/ask/run

Run an edited plan (the chips) without the model

Validated and scoped exactly like a question; no AI credits. Works when AI is unavailable.

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

Request body

planrequired: AskPlanInput
An Ask PropZolo query, or a named report with its period.

Response · 200

datarequired: object
data.resultrequired: AskResult
data.labelsrequired: map of map of string
Value labels the catalogue cannot give the chips (locality id → name).
data.queryrequired: AggregateQuery or null
Ask PropZolo query: an entity, a filter (shared filter DSL), a calendar range, measures, one group-by, sort, top-N.
data.descriptionrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/ask/run' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"plan":{"kind":"query","query":{"entity":"string","filter":null,"range":{"field":"string","preset":"today","from":"string","to":"string"},"measures":[{"fn":"count","field":"string"}],"group_by":{"field":"string","bucket":"day"},"sort":{"by":"value","field":"string","dir":"asc"},"limit":1}}}'

Response example

{
  "data": {
    "result": {
      "mode": "list",
      "entity": "string",
      "title": "string",
      "columns": [
        {
          "key": "string",
          "label": "string",
          "kind": "text"
        }
      ],
      "rows": [
        {
          "key": "string",
          "label": "string",
          "name": "string",
          "cells": {},
          "link": "string",
          "filter": null
        }
      ],
      "totals": {},
      "matched": 0,
      "truncated": true,
      "range": {
        "label": "string",
        "from_day": "string",
        "to_day": "string"
      },
      "notes": [
        "string"
      ]
    },
    "labels": {},
    "query": {
      "entity": "string",
      "filter": null,
      "range": {
        "field": "string",
        "preset": "today",
        "from": "string",
        "to": "string"
      },
      "measures": [
        {
          "fn": "count",
          "field": "string"
        }
      ],
      "group_by": {
        "field": "string",
        "bucket": "day"
      },
      "sort": {
        "by": "value",
        "field": "string",
        "dir": "asc"
      },
      "limit": 1
    },
    "description": "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/ai/ask/smart-list

Save a lead or contact question as a smart list (a saved view; its period becomes fixed dates)

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

Request body

queryrequired: AggregateQuery
Ask PropZolo query: an entity, a filter (shared filter DSL), a calendar range, measures, one group-by, sort, top-N.
name: string or null
visibility: "private" | "team"
question: string or null

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.entityrequired: string
data.namerequired: string
data.visibilityrequired: SavedViewVisibility
data.filtersrequired: FilterNode or null
PropZolo filter: { all: [...] } | { any: [...] } | { not: … } | { field, op, value }
data.columnsrequired: array of string or null
Visible column ids in order; null = defaults.
data.sortrequired: string or null
List sort, e.g. -received_at.
data.layoutrequired: SavedViewLayout
data.is_pinnedrequired: boolean
data.authorrequired: MemberRef or null
data.minerequired: boolean
The caller wrote it.
data.editablerequired: boolean
The caller may change, re-share or delete it.
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.fixed_rangerequired: string or null
The period saved as fixed dates, when there was one.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/ask/smart-list' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"query":{"entity":"string","filter":null,"range":{"field":"string","preset":"today","from":"string","to":"string"},"measures":[{"fn":"count","field":"string"}],"group_by":{"field":"string","bucket":"day"},"sort":{"by":"value","field":"string","dir":"asc"},"limit":1},"name":"string","visibility":"private","question":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "entity": "string",
    "name": "string",
    "visibility": "private",
    "filters": null,
    "columns": [
      "string"
    ],
    "sort": "string",
    "layout": "table",
    "is_pinned": true,
    "author": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "mine": true,
    "editable": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "fixed_range": "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/ai/conversation-summary

Summarise a conversation: needs, facts, open questions, next steps, sentiment

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

Request body

conversation_idrequired: Id
Opaque record id.
output_language: "en" | "hi"

Response · 200

datarequired: object
data.summaryrequired: AiConversationSummary
data.findingsrequired: array of AiFinding
A validator decision on an AI output (grounding, compliance, PII, route rules).
data.blockedrequired: boolean
A blocking finding: a person must edit the output before it is used.
data.creditsrequired: integer
data.request_idrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/conversation-summary' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"conversation_id":"cmusrceel0000q7kaafxqi1om","output_language":"en"}'

Response example

{
  "data": {
    "summary": {
      "summary": "string",
      "customer_needs": [
        "string"
      ],
      "key_facts": [
        "string"
      ],
      "open_questions": [
        "string"
      ],
      "next_steps": [
        {
          "action": "string",
          "owner": "string",
          "due": "string"
        }
      ],
      "sentiment": "string",
      "customer_language": "string",
      "handoff_recommended": true
    },
    "findings": [
      {
        "validator": "grounding",
        "code": "string",
        "severity": "info",
        "message": "string",
        "path": "string",
        "match": "string",
        "action": "flagged"
      }
    ],
    "blocked": true,
    "credits": 0,
    "request_id": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

POST/v1/ai/feedback

Rate an AI result (helpful or not)

Your own AI results of the last 7 days only (another member’s or company’s is a 404). A later rating of the same result replaces the earlier one; kept on the audit trail for AI admins.

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

Request body

request_idrequired: string
The `request_id` of the AI answer rated.
ratingrequired: "up" | "down"
comment: string or null

Response · 200

datarequired: object
data.request_idrequired: string
data.ratingrequired: "up" | "down"
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/feedback' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"request_id":"string","rating":"up","comment":"string"}'

Response example

{
  "data": {
    "request_id": "string",
    "rating": "up"
  },
  "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/ai/history

Recent AI actions (the caller’s own; the whole company’s for AI admins)

Access: API key or member session. Permission ai.copilot.

Parameters

scopequery: "mine" | "company"
cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer

Response · 200

datarequired: array of AiHistoryItem
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "route": "string",
      "label": "string",
      "status": "string",
      "error_code": "string",
      "preview": "string",
      "credits": 0,
      "findings": 0,
      "entity": {
        "type": "string",
        "id": "string"
      },
      "member_id": "string",
      "created_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.

GET/v1/ai/inventory

The inventory inbox: parsed broker posts, newest first

Access: API key or member session. Permission ai.inventory_inbox.

Parameters

statusquery: "new" | "imported" | "ignored" | "all"
cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer

Response · 200

datarequired: array of InventoryPost
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "source": "string",
      "poster": {
        "name": "string",
        "phone": "string"
      },
      "raw_text": "string",
      "kind": "string",
      "status": "string",
      "confidence": 0,
      "language": "string",
      "noise_reason": "string",
      "property_id": "string",
      "posted_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "items": [
        {
          "index": 0,
          "kind": "listing",
          "transaction": {
            "value": null,
            "confidence": 0
          },
          "property_type": {
            "value": null,
            "confidence": 0
          },
          "bhk": {
            "value": null,
            "confidence": 0
          },
          "area": {
            "value": null,
            "confidence": 0
          },
          "price_rupees": {
            "value": null,
            "confidence": 0
          },
          "price_min_rupees": {
            "value": null,
            "confidence": 0
          },
          "rent_rupees": {
            "value": null,
            "confidence": 0
          },
          "deposit_rupees": {
            "value": null,
            "confidence": 0
          },
          "price_terms": [
            "string"
          ],
          "furnishing": {
            "value": null,
            "confidence": 0
          },
          "floor": {
            "value": null,
            "confidence": 0
          },
          "facing": {
            "value": null,
            "confidence": 0
          },
          "parking": {
            "value": null,
            "confidence": 0
          },
          "possession": {
            "value": null,
            "confidence": 0
          },
          "possession_date": {
            "value": null,
            "confidence": 0
          },
          "oc_received": {
            "value": null,
            "confidence": 0
          },
          "rera_number": {
            "value": null,
            "confidence": 0
          },
          "project": {
            "value": null,
            "confidence": 0
          },
          "locality": {
            "value": null,
            "confidence": 0
          },
          "landmark": {
            "value": null,
            "confidence": 0
          },
          "city": {
            "value": null,
            "confidence": 0
          },
          "tenant_preference": {
            "value": null,
            "confidence": 0
          },
          "available_from": {
            "value": null,
            "confidence": 0
          },
          "co_broke_terms": {
            "value": null,
            "confidence": 0
          },
          "contacts": [
            {
              "name": null,
              "phone": null
            }
          ],
          "amenities": [
            "string"
          ],
          "raw_excerpt": "string",
          "review_fields": [
            "string"
          ],
          "confidence": 0,
          "review": {
            "state": "pending",
            "created": {
              "type": null,
              "id": null,
              "ref": null
            },
            "status": "string",
            "decided_by": "string",
            "decided_at": "string"
          }
        }
      ]
    }
  ],
  "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/ai/inventory

Parse a pasted or forwarded broker message into review cards

Third-party phone numbers stay private to the company and are masked like contact phones.

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

Request body

textrequired: string
source: "paste" | "whatsapp_forward" | "whatsapp_group" | "share" | "chat_export" | "email"
poster: object or null
poster.name: string or null
poster.phone: string or null
default_city: string or null

Response · 201

datarequired: object
data.postrequired: InventoryPost
data.findingsrequired: array of AiFinding
A validator decision on an AI output (grounding, compliance, PII, route rules).
data.blockedrequired: boolean
A blocking finding: a person must edit the output before it is used.
data.creditsrequired: integer
data.request_idrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/inventory' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"text":"string","source":"paste","poster":{"name":"string","phone":"string"},"default_city":"string"}'

Response example

{
  "data": {
    "post": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "source": "string",
      "poster": {
        "name": "string",
        "phone": "string"
      },
      "raw_text": "string",
      "kind": "string",
      "status": "string",
      "confidence": 0,
      "language": "string",
      "noise_reason": "string",
      "property_id": "string",
      "posted_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "items": [
        {
          "index": 0,
          "kind": "listing",
          "transaction": {
            "value": null,
            "confidence": 0
          },
          "property_type": {
            "value": null,
            "confidence": 0
          },
          "bhk": {
            "value": null,
            "confidence": 0
          },
          "area": {
            "value": null,
            "confidence": 0
          },
          "price_rupees": {
            "value": null,
            "confidence": 0
          },
          "price_min_rupees": {
            "value": null,
            "confidence": 0
          },
          "rent_rupees": {
            "value": null,
            "confidence": 0
          },
          "deposit_rupees": {
            "value": null,
            "confidence": 0
          },
          "price_terms": [
            "string"
          ],
          "furnishing": {
            "value": null,
            "confidence": 0
          },
          "floor": {
            "value": null,
            "confidence": 0
          },
          "facing": {
            "value": null,
            "confidence": 0
          },
          "parking": {
            "value": null,
            "confidence": 0
          },
          "possession": {
            "value": null,
            "confidence": 0
          },
          "possession_date": {
            "value": null,
            "confidence": 0
          },
          "oc_received": {
            "value": null,
            "confidence": 0
          },
          "rera_number": {
            "value": null,
            "confidence": 0
          },
          "project": {
            "value": null,
            "confidence": 0
          },
          "locality": {
            "value": null,
            "confidence": 0
          },
          "landmark": {
            "value": null,
            "confidence": 0
          },
          "city": {
            "value": null,
            "confidence": 0
          },
          "tenant_preference": {
            "value": null,
            "confidence": 0
          },
          "available_from": {
            "value": null,
            "confidence": 0
          },
          "co_broke_terms": {
            "value": null,
            "confidence": 0
          },
          "contacts": [
            {
              "name": null,
              "phone": null
            }
          ],
          "amenities": [
            "string"
          ],
          "raw_excerpt": "string",
          "review_fields": [
            "string"
          ],
          "confidence": 0,
          "review": {
            "state": "pending",
            "created": {
              "type": null,
              "id": null,
              "ref": null
            },
            "status": "string",
            "decided_by": "string",
            "decided_at": "string"
          }
        }
      ]
    },
    "findings": [
      {
        "validator": "grounding",
        "code": "string",
        "severity": "info",
        "message": "string",
        "path": "string",
        "match": "string",
        "action": "flagged"
      }
    ],
    "blocked": true,
    "credits": 0,
    "request_id": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

GET/v1/ai/inventory/{id}

One inventory post with its cards

Access: API key or member session. Permission ai.inventory_inbox.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: InventoryPost
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "source": "string",
    "poster": {
      "name": "string",
      "phone": "string"
    },
    "raw_text": "string",
    "kind": "string",
    "status": "string",
    "confidence": 0,
    "language": "string",
    "noise_reason": "string",
    "property_id": "string",
    "posted_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "items": [
      {
        "index": 0,
        "kind": "listing",
        "transaction": {
          "value": null,
          "confidence": 0
        },
        "property_type": {
          "value": null,
          "confidence": 0
        },
        "bhk": {
          "value": null,
          "confidence": 0
        },
        "area": {
          "value": null,
          "confidence": 0
        },
        "price_rupees": {
          "value": null,
          "confidence": 0
        },
        "price_min_rupees": {
          "value": null,
          "confidence": 0
        },
        "rent_rupees": {
          "value": null,
          "confidence": 0
        },
        "deposit_rupees": {
          "value": null,
          "confidence": 0
        },
        "price_terms": [
          "string"
        ],
        "furnishing": {
          "value": null,
          "confidence": 0
        },
        "floor": {
          "value": null,
          "confidence": 0
        },
        "facing": {
          "value": null,
          "confidence": 0
        },
        "parking": {
          "value": null,
          "confidence": 0
        },
        "possession": {
          "value": null,
          "confidence": 0
        },
        "possession_date": {
          "value": null,
          "confidence": 0
        },
        "oc_received": {
          "value": null,
          "confidence": 0
        },
        "rera_number": {
          "value": null,
          "confidence": 0
        },
        "project": {
          "value": null,
          "confidence": 0
        },
        "locality": {
          "value": null,
          "confidence": 0
        },
        "landmark": {
          "value": null,
          "confidence": 0
        },
        "city": {
          "value": null,
          "confidence": 0
        },
        "tenant_preference": {
          "value": null,
          "confidence": 0
        },
        "available_from": {
          "value": null,
          "confidence": 0
        },
        "co_broke_terms": {
          "value": null,
          "confidence": 0
        },
        "contacts": [
          {
            "name": "string",
            "phone": "string"
          }
        ],
        "amenities": [
          "string"
        ],
        "raw_excerpt": "string",
        "review_fields": [
          "string"
        ],
        "confidence": 0,
        "review": {
          "state": "pending",
          "created": {
            "type": "property",
            "id": "cmusrceel0000q7kaafxqi1om",
            "ref": "string"
          },
          "status": "string",
          "decided_by": "string",
          "decided_at": "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/ai/inventory/{id}/cards/{index}

Accept a card (creates a private listing or a lead; matching starts) or reject it

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

Parameters

idpathrequired: Id
Opaque record id.
indexpathrequired: integer

Request body

actionrequired: "accept" | "reject"
edits: InventoryCardEdits

Response · 200

datarequired: InventoryPost
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/inventory/{id}/cards/{index}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"accept","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"}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "source": "string",
    "poster": {
      "name": "string",
      "phone": "string"
    },
    "raw_text": "string",
    "kind": "string",
    "status": "string",
    "confidence": 0,
    "language": "string",
    "noise_reason": "string",
    "property_id": "string",
    "posted_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "items": [
      {
        "index": 0,
        "kind": "listing",
        "transaction": {
          "value": null,
          "confidence": 0
        },
        "property_type": {
          "value": null,
          "confidence": 0
        },
        "bhk": {
          "value": null,
          "confidence": 0
        },
        "area": {
          "value": null,
          "confidence": 0
        },
        "price_rupees": {
          "value": null,
          "confidence": 0
        },
        "price_min_rupees": {
          "value": null,
          "confidence": 0
        },
        "rent_rupees": {
          "value": null,
          "confidence": 0
        },
        "deposit_rupees": {
          "value": null,
          "confidence": 0
        },
        "price_terms": [
          "string"
        ],
        "furnishing": {
          "value": null,
          "confidence": 0
        },
        "floor": {
          "value": null,
          "confidence": 0
        },
        "facing": {
          "value": null,
          "confidence": 0
        },
        "parking": {
          "value": null,
          "confidence": 0
        },
        "possession": {
          "value": null,
          "confidence": 0
        },
        "possession_date": {
          "value": null,
          "confidence": 0
        },
        "oc_received": {
          "value": null,
          "confidence": 0
        },
        "rera_number": {
          "value": null,
          "confidence": 0
        },
        "project": {
          "value": null,
          "confidence": 0
        },
        "locality": {
          "value": null,
          "confidence": 0
        },
        "landmark": {
          "value": null,
          "confidence": 0
        },
        "city": {
          "value": null,
          "confidence": 0
        },
        "tenant_preference": {
          "value": null,
          "confidence": 0
        },
        "available_from": {
          "value": null,
          "confidence": 0
        },
        "co_broke_terms": {
          "value": null,
          "confidence": 0
        },
        "contacts": [
          {
            "name": "string",
            "phone": "string"
          }
        ],
        "amenities": [
          "string"
        ],
        "raw_excerpt": "string",
        "review_fields": [
          "string"
        ],
        "confidence": 0,
        "review": {
          "state": "pending",
          "created": {
            "type": "property",
            "id": "cmusrceel0000q7kaafxqi1om",
            "ref": "string"
          },
          "status": "string",
          "decided_by": "string",
          "decided_at": "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/ai/leads/{id}/explain

"Explain this lead": why it is hot or cold, with evidence, and the next best action

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.explanationrequired: AiLeadExplanation
data.findingsrequired: array of AiFinding
A validator decision on an AI output (grounding, compliance, PII, route rules).
data.blockedrequired: boolean
A blocking finding: a person must edit the output before it is used.
data.creditsrequired: integer
data.request_idrequired: string
metarequired: object

Request

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

Response example

{
  "data": {
    "explanation": {
      "temperature": "hot",
      "reasons": [
        {
          "signal": "string",
          "evidence": "string",
          "effect": "raises",
          "strength": "strong"
        }
      ],
      "next_best_action": {
        "action": "string",
        "detail": "string",
        "when": "string"
      },
      "missing_information": [
        "string"
      ]
    },
    "findings": [
      {
        "validator": "grounding",
        "code": "string",
        "severity": "info",
        "message": "string",
        "path": "string",
        "match": "string",
        "action": "flagged"
      }
    ],
    "blocked": true,
    "credits": 0,
    "request_id": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

POST/v1/ai/leads/{id}/requirement

"Fill from notes": requirement proposals from the lead’s notes (or the given text)

Nothing is written: accept proposals with `POST /api/v1/ai/leads/{id}/requirement/apply`.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

text: string or null
source: "note" | "chat" | "enquiry" | "call_note" | "portal_email" | "other"

Response · 200

datarequired: object
data.proposalsrequired: array of RequirementProposal
One field the AI read from the notes, compared with the lead.
data.findingsrequired: array of AiFinding
A validator decision on an AI output (grounding, compliance, PII, route rules).
data.blockedrequired: boolean
A blocking finding: a person must edit the output before it is used.
data.creditsrequired: integer
data.request_idrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/leads/{id}/requirement' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"text":"string","source":"note"}'

Response example

{
  "data": {
    "proposals": [
      {
        "key": "string",
        "label": "string",
        "current": "string",
        "proposed": "string",
        "confidence": 0,
        "status": "stated",
        "evidence": "string",
        "conflict": true,
        "suggested": true,
        "patch": {
          "lead_type": "buy",
          "requirement": {
            "category": "residential",
            "property_types": [
              null
            ],
            "bhk": [
              null
            ],
            "budget_min": null,
            "budget_max": null,
            "area_min_sqft": 0,
            "area_max_sqft": 0,
            "area_unit_display": "sqft",
            "locality_ids": [
              null
            ],
            "location_text": "string",
            "possession": "string",
            "transaction_types": [
              null
            ],
            "furnishing": [
              null
            ],
            "facing": [
              null
            ],
            "floor_preference": "string",
            "min_bathrooms": 0,
            "parking_required": true,
            "amenity_ids": [
              null
            ],
            "vastu_required": true,
            "purpose": "string",
            "loan_required": true,
            "loan_status": "string",
            "buy_within": "string",
            "move_in_by": "string",
            "lease_months": 0,
            "tenant_profile": "string",
            "family_size": 0,
            "has_pets": true,
            "notes": "string"
          }
        }
      }
    ],
    "findings": [
      {
        "validator": "grounding",
        "code": "string",
        "severity": "info",
        "message": "string",
        "path": "string",
        "match": "string",
        "action": "flagged"
      }
    ],
    "blocked": true,
    "credits": 0,
    "request_id": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

POST/v1/ai/leads/{id}/requirement/apply

Apply the accepted proposals to the lead (an ordinary lead update plus an AI timeline entry)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

lead_type: LeadType
requirement: RequirementInput
fieldsrequired: array of string
ai_request_id: string or null

Response · 200

datarequired: object
data.lead_idrequired: Id
Opaque record id.
data.lead_typerequired: LeadType
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/leads/{id}/requirement/apply' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_type":"buy","requirement":{"category":"residential","property_types":["apartment"],"bhk":[0],"budget_min":0,"budget_max":0,"area_min_sqft":0,"area_max_sqft":0,"area_unit_display":"sqft","locality_ids":["cmusrceel0000q7kaafxqi1om"],"location_text":"string","possession":"string","transaction_types":["new_booking"],"furnishing":["unfurnished"],"facing":["north"],"floor_preference":"string","min_bathrooms":0,"parking_required":true,"amenity_ids":["cmusrceel0000q7kaafxqi1om"],"vastu_required":true,"purpose":"string","loan_required":true,"loan_status":"string","buy_within":"string","move_in_by":"string","lease_months":0,"tenant_profile":"string","family_size":0,"has_pets":true,"notes":"string"},"fields":["string"],"ai_request_id":"string"}'

Response example

{
  "data": {
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "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.
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/ai/leads/{id}/score

A lead’s score with its reasons

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: LeadScore
0–100 score: the rules with recency decay, or the company’s predictive model once it passed its checks; closed leads have no score.
metarequired: object

Request

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

Response example

{
  "data": {
    "score": 0,
    "band": "hot",
    "computed_at": "string",
    "reasons": [
      {
        "factor": "string",
        "points": 0,
        "text": "string"
      }
    ],
    "intents": [
      {
        "intent": "string",
        "confidence": 0,
        "at": "string",
        "message_id": "string"
      }
    ],
    "source": "string",
    "probability": 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.
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/ai/leads/{id}/score

Recompute a lead’s score now (scores also follow lead events and a nightly pass)

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: LeadScore
0–100 score: the rules with recency decay, or the company’s predictive model once it passed its checks; closed leads have no score.
metarequired: object

Request

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

Response example

{
  "data": {
    "score": 0,
    "band": "hot",
    "computed_at": "string",
    "reasons": [
      {
        "factor": "string",
        "points": 0,
        "text": "string"
      }
    ],
    "intents": [
      {
        "intent": "string",
        "confidence": 0,
        "at": "string",
        "message_id": "string"
      }
    ],
    "source": "string",
    "probability": 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.
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/ai/leads/{id}/summary

AI summary of a lead for the agent opening it

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.summaryrequired: AiLeadSummary
data.findingsrequired: array of AiFinding
A validator decision on an AI output (grounding, compliance, PII, route rules).
data.blockedrequired: boolean
A blocking finding: a person must edit the output before it is used.
data.creditsrequired: integer
data.request_idrequired: string
metarequired: object

Request

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

Response example

{
  "data": {
    "summary": {
      "headline": "string",
      "summary": "string",
      "requirement_line": "string",
      "status_line": "string",
      "last_interaction": "string",
      "next_step": "string",
      "flags": [
        "string"
      ]
    },
    "findings": [
      {
        "validator": "grounding",
        "code": "string",
        "severity": "info",
        "message": "string",
        "path": "string",
        "match": "string",
        "action": "flagged"
      }
    ],
    "blocked": true,
    "credits": 0,
    "request_id": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

POST/v1/ai/listing-copy

Title, description, highlights and a WhatsApp caption from the listing’s own facts

Nothing is saved: the agent edits the copy and saves it with the listing.

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

Request body

property_idrequired: Id
Opaque record id.
language: "en" | "hi"
audience: "portal" | "website" | "whatsapp"
tone: "professional" | "warm" | "premium"

Response · 200

datarequired: object
data.copyrequired: AiListingCopy
data.findingsrequired: array of AiFinding
A validator decision on an AI output (grounding, compliance, PII, route rules).
data.blockedrequired: boolean
A blocking finding: a person must edit the output before it is used.
data.creditsrequired: integer
data.request_idrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/listing-copy' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"property_id":"cmusrceel0000q7kaafxqi1om","language":"en","audience":"portal","tone":"professional"}'

Response example

{
  "data": {
    "copy": {
      "title": "string",
      "description": "string",
      "highlights": [
        "string"
      ],
      "whatsapp_text": "string",
      "rera_line": "string",
      "missing_facts": [
        "string"
      ]
    },
    "findings": [
      {
        "validator": "grounding",
        "code": "string",
        "severity": "info",
        "message": "string",
        "path": "string",
        "match": "string",
        "action": "flagged"
      }
    ],
    "blocked": true,
    "credits": 0,
    "request_id": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

POST/v1/ai/reply-draft

Draft the next reply in a conversation (English, Hindi or Hinglish; template-only when the window is closed)

Never sends anything: the agent reviews and edits the draft in the composer.

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

Request body

conversation_idrequired: Id
Opaque record id.
language: "auto" | "en" | "hi" | "hinglish"
tone: "friendly" | "professional" | "concise" | "premium"
instruction: string or null

Response · 200

datarequired: object
data.draftrequired: AiReplyDraft
data.windowrequired: object
data.window.openrequired: boolean
data.window.closes_atrequired: string or null
data.findingsrequired: array of AiFinding
A validator decision on an AI output (grounding, compliance, PII, route rules).
data.blockedrequired: boolean
A blocking finding: a person must edit the output before it is used.
data.creditsrequired: integer
data.request_idrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/reply-draft' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"conversation_id":"cmusrceel0000q7kaafxqi1om","language":"auto","tone":"friendly","instruction":"string"}'

Response example

{
  "data": {
    "draft": {
      "mode": "free_text",
      "language": "en",
      "reply_parts": [
        {
          "text": "string"
        }
      ],
      "template": {
        "template_id": "string",
        "variables": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      },
      "needs_human": true,
      "handoff_reason": "string",
      "unanswered_questions": [
        "string"
      ],
      "facts_used": [
        "string"
      ]
    },
    "window": {
      "open": true,
      "closes_at": "string"
    },
    "findings": [
      {
        "validator": "grounding",
        "code": "string",
        "severity": "info",
        "message": "string",
        "path": "string",
        "match": "string",
        "action": "flagged"
      }
    ],
    "blocked": true,
    "credits": 0,
    "request_id": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

GET/v1/ai/reports

The caller’s saved reports and the team’s

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

Response · 200

datarequired: array of SavedReport
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "query",
      "definition": {
        "kind": "query",
        "query": {
          "entity": "string",
          "filter": null,
          "range": {
            "field": null,
            "preset": null,
            "from": null,
            "to": null
          },
          "measures": [
            null
          ],
          "group_by": {
            "field": null,
            "bucket": null
          },
          "sort": {
            "by": null,
            "field": null,
            "dir": null
          },
          "limit": 1
        }
      },
      "chart": "auto",
      "question": "string",
      "visibility": "private",
      "is_pinned": true,
      "author": {
        "id": "string",
        "name": "string"
      },
      "mine": true,
      "editable": true,
      "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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/ai/reports

Save a question as a report definition (it must run for its author)

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

Request body

definitionrequired: AskPlan2
An Ask PropZolo query, or a named report with its period.
name: string or null
chart: "auto" | "table" | "bar" | "line"
visibility: "private" | "team"
question: string or null

Response · 201

datarequired: SavedReport
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/reports' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"definition":{"kind":"query","query":{"entity":"string","filter":null,"range":{"field":"string","preset":"today","from":"string","to":"string"},"measures":[{"fn":"count","field":"string"}],"group_by":{"field":"string","bucket":"day"},"sort":{"by":"value","field":"string","dir":"asc"},"limit":1}},"name":"string","chart":"auto","visibility":"private","question":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "kind": "query",
    "definition": {
      "kind": "query",
      "query": {
        "entity": "string",
        "filter": null,
        "range": {
          "field": "string",
          "preset": "today",
          "from": "string",
          "to": "string"
        },
        "measures": [
          {
            "fn": null,
            "field": null
          }
        ],
        "group_by": {
          "field": "string",
          "bucket": "day"
        },
        "sort": {
          "by": "value",
          "field": "string",
          "dir": "asc"
        },
        "limit": 1
      }
    },
    "chart": "auto",
    "question": "string",
    "visibility": "private",
    "is_pinned": true,
    "author": {
      "id": "string",
      "name": "string"
    },
    "mine": true,
    "editable": true,
    "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.
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/ai/reports/{id}

A saved report with its result, run now with the viewer’s scope

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.reportrequired: SavedReport
data.resultrequired: AskResult or null
data.labelsrequired: map of map of string
Value labels the catalogue cannot give the chips (locality id → name).
data.descriptionrequired: string
data.errorrequired: string or null
metarequired: object

Request

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

Response example

{
  "data": {
    "report": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "query",
      "definition": {
        "kind": "query",
        "query": {
          "entity": "string",
          "filter": null,
          "range": {
            "field": null,
            "preset": null,
            "from": null,
            "to": null
          },
          "measures": [
            null
          ],
          "group_by": {
            "field": null,
            "bucket": null
          },
          "sort": {
            "by": null,
            "field": null,
            "dir": null
          },
          "limit": 1
        }
      },
      "chart": "auto",
      "question": "string",
      "visibility": "private",
      "is_pinned": true,
      "author": {
        "id": "string",
        "name": "string"
      },
      "mine": true,
      "editable": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "result": {
      "mode": "list",
      "entity": "string",
      "title": "string",
      "columns": [
        {
          "key": "string",
          "label": "string",
          "kind": "text"
        }
      ],
      "rows": [
        {
          "key": "string",
          "label": "string",
          "name": "string",
          "cells": {},
          "link": "string",
          "filter": null
        }
      ],
      "totals": {},
      "matched": 0,
      "truncated": true,
      "range": {
        "label": "string",
        "from_day": "string",
        "to_day": "string"
      },
      "notes": [
        "string"
      ]
    },
    "labels": {},
    "description": "string",
    "error": "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.

PATCH/v1/ai/reports/{id}

Rename, pin, share or chart a saved report (its author; team reports also settings.company)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
chart: "auto" | "table" | "bar" | "line"
is_pinned: boolean
visibility: "private" | "team"

Response · 200

datarequired: SavedReport
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/ai/reports/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","chart":"auto","is_pinned":true,"visibility":"private"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "kind": "query",
    "definition": {
      "kind": "query",
      "query": {
        "entity": "string",
        "filter": null,
        "range": {
          "field": "string",
          "preset": "today",
          "from": "string",
          "to": "string"
        },
        "measures": [
          {
            "fn": null,
            "field": null
          }
        ],
        "group_by": {
          "field": "string",
          "bucket": "day"
        },
        "sort": {
          "by": "value",
          "field": "string",
          "dir": "asc"
        },
        "limit": 1
      }
    },
    "chart": "auto",
    "question": "string",
    "visibility": "private",
    "is_pinned": true,
    "author": {
      "id": "string",
      "name": "string"
    },
    "mine": true,
    "editable": true,
    "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/ai/reports/{id}

Delete a saved report

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.deletedrequired: true
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "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/ai/requirement-extract

A requirement from free text (an enquiry, a chat) with per-field confidence and evidence

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

Request body

textrequired: string
source: "enquiry" | "note" | "chat" | "portal_email" | "call_note" | "other"
city: string or null

Response · 200

datarequired: object
data.requirementrequired: map of any
data.findingsrequired: array of AiFinding
A validator decision on an AI output (grounding, compliance, PII, route rules).
data.blockedrequired: boolean
A blocking finding: a person must edit the output before it is used.
data.creditsrequired: integer
data.request_idrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/requirement-extract' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"text":"string","source":"enquiry","city":"string"}'

Response example

{
  "data": {
    "requirement": {},
    "findings": [
      {
        "validator": "grounding",
        "code": "string",
        "severity": "info",
        "message": "string",
        "path": "string",
        "match": "string",
        "action": "flagged"
      }
    ],
    "blocked": true,
    "credits": 0,
    "request_id": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

POST/v1/ai/search/leads

Plain-words lead search → a validated filter (editable chips) for the leads list

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

Request body

queryrequired: string

Response · 200

datarequired: object
data.filterrequired: any or null
Leads filter tree (shared filter DSL), null when nothing matched.
data.chipsrequired: array of AiSearchChip
data.unmatchedrequired: array of string
data.droppedrequired: array of string
data.explanationrequired: string
data.locality_namesrequired: map of string
Locality id → name, for the filter chips.
data.findingsrequired: array of AiFinding
A validator decision on an AI output (grounding, compliance, PII, route rules).
data.blockedrequired: boolean
A blocking finding: a person must edit the output before it is used.
data.creditsrequired: integer
data.request_idrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/search/leads' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"query":"string"}'

Response example

{
  "data": {
    "filter": null,
    "chips": [
      {
        "field": "string",
        "label": "string",
        "op": "string",
        "value": null,
        "text": "string",
        "index": 0
      }
    ],
    "unmatched": [
      "string"
    ],
    "dropped": [
      "string"
    ],
    "explanation": "string",
    "locality_names": {},
    "findings": [
      {
        "validator": "grounding",
        "code": "string",
        "severity": "info",
        "message": "string",
        "path": "string",
        "match": "string",
        "action": "flagged"
      }
    ],
    "blocked": true,
    "credits": 0,
    "request_id": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

POST/v1/ai/segments

A natural-language audience → a proposed lead filter with its count (F-02 AI Segment)

The model sees only the lead field catalogue and the company’s option lists, never lead data. The filter is checked like the plain-words lead search and counted over the leads you may see (before opt-outs, DND and duplicates are removed at build). Nothing is applied: you confirm or edit it in the broadcast audience or the workflow step.

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

Request body

textrequired: string
purpose: "broadcast" | "workflow"

Response · 200

datarequired: object
data.filterrequired: any or null
Leads filter tree (shared filter DSL), null for everyone.
data.namerequired: string
data.countrequired: integer
data.chipsrequired: array of AiSearchChip
data.unmatchedrequired: array of string
data.droppedrequired: array of string
data.explanationrequired: string
data.locality_namesrequired: map of string
data.findingsrequired: array of AiFinding
A validator decision on an AI output (grounding, compliance, PII, route rules).
data.blockedrequired: boolean
A blocking finding: a person must edit the output before it is used.
data.creditsrequired: integer
data.request_idrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/ai/segments' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"text":"string","purpose":"broadcast"}'

Response example

{
  "data": {
    "filter": null,
    "name": "string",
    "count": 0,
    "chips": [
      {
        "field": "string",
        "label": "string",
        "op": "string",
        "value": null,
        "text": "string",
        "index": 0
      }
    ],
    "unmatched": [
      "string"
    ],
    "dropped": [
      "string"
    ],
    "explanation": "string",
    "locality_names": {},
    "findings": [
      {
        "validator": "grounding",
        "code": "string",
        "severity": "info",
        "message": "string",
        "path": "string",
        "match": "string",
        "action": "flagged"
      }
    ],
    "blocked": true,
    "credits": 0,
    "request_id": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

PATCH/v1/ai/settings

Change the company AI settings (switch, monthly credit cap, intent signals, voice)

Access: API key or member session. Permission ai.agents_manage.

Request body

enabled: boolean
monthly_credit_cap: integer or null
intent_signals: boolean
persona: string or null
instructions: string or null
price_policy: "exact" | "band" | "never"
compliance: object
compliance.banned_phrasesrequired: array of string
compliance.disabled_rulesrequired: array of string

Response · 200

datarequired: AiSettings
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/ai/settings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"monthly_credit_cap":0,"intent_signals":true,"persona":"string","instructions":"string","price_policy":"exact","compliance":{"banned_phrases":["string"],"disabled_rules":["string"]}}'

Response example

{
  "data": {
    "enabled": true,
    "monthly_credit_cap": 0,
    "intent_signals": true,
    "persona": "string",
    "instructions": "string",
    "price_policy": "exact",
    "compliance": {
      "banned_phrases": [
        "string"
      ],
      "disabled_rules": [
        "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/ai/status

Whether AI features can run for the caller, and why not

For the friendly disabled state of every AI button: platform set-up, company switch, permission, credits.

Access: API key or member session.

Response · 200

datarequired: AiStatus
metarequired: object

Request

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

Response example

{
  "data": {
    "available": true,
    "reason": "not_configured",
    "message": "string",
    "configured": true,
    "enabled": true,
    "permissions": {
      "copilot": true,
      "inventory_inbox": true,
      "manage": true
    },
    "credits": {
      "available": 0,
      "low_balance": 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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/ai/usage

AI usage: credits this month, by feature and per day, the wallet and the settings

Needs `billing.view` or `ai.agents_manage`.

Access: API key or member session. Permission billing.view or ai.agents_manage.

Response · 200

datarequired: AiUsage
metarequired: object

Request

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

Response example

{
  "data": {
    "settings": {
      "enabled": true,
      "monthly_credit_cap": 0,
      "intent_signals": true,
      "persona": "string",
      "instructions": "string",
      "price_policy": "exact",
      "compliance": {
        "banned_phrases": [
          "string"
        ],
        "disabled_rules": [
          "string"
        ]
      }
    },
    "month": {
      "period_start": "string",
      "credits": 0,
      "runs": 0,
      "cap": 0
    },
    "wallet": {
      "balance": 0,
      "available": 0,
      "low_balance": true,
      "disabled": true
    },
    "by_feature": [
      {
        "feature": "string",
        "label": "string",
        "runs": 0,
        "credits": 0
      }
    ],
    "daily": [
      {
        "date": "string",
        "runs": 0,
        "credits": 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.

GET/v1/me/briefing

The caller’s briefing for today (built on first open, refreshed when half an hour old)

Agents: who to call and why, overdue follow-ups, today’s visits. Managers: SLA breaches and records at risk, stuck deals, visits without feedback, the team against the day before. Scoped to what the member may see.

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

Parameters

refreshquery: "true" | "false"

Response · 200

datarequired: DailyBriefing
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "day": "string",
    "role": "agent",
    "content": {
      "version": 1,
      "role": "agent",
      "day": "string",
      "day_label": "string",
      "headline": "string",
      "stats": [
        {
          "key": "string",
          "label": "string",
          "value": "string",
          "tone": "danger",
          "hint": "string"
        }
      ],
      "sections": [
        {
          "key": "string",
          "title": "string",
          "items": [
            {
              "id": null,
              "ref": null,
              "title": null,
              "detail": null,
              "link": null,
              "tone": null
            }
          ],
          "more": 0,
          "link": "string"
        }
      ]
    },
    "summary": {
      "summary": "string",
      "focus": "string",
      "source": "ai"
    },
    "summary_status": "none",
    "ai_summary": true,
    "generated_at": "2026-10-06T05:30:00.000Z",
    "acknowledged_at": "2026-10-06T05:30:00.000Z",
    "show": 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.
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/me/briefing/ack

“Start my day”: the briefing modal stays closed for the rest of the day

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

Response · 200

datarequired: DailyBriefing
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/me/briefing/ack' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "day": "string",
    "role": "agent",
    "content": {
      "version": 1,
      "role": "agent",
      "day": "string",
      "day_label": "string",
      "headline": "string",
      "stats": [
        {
          "key": "string",
          "label": "string",
          "value": "string",
          "tone": "danger",
          "hint": "string"
        }
      ],
      "sections": [
        {
          "key": "string",
          "title": "string",
          "items": [
            {
              "id": null,
              "ref": null,
              "title": null,
              "detail": null,
              "link": null,
              "tone": null
            }
          ],
          "more": 0,
          "link": "string"
        }
      ]
    },
    "summary": {
      "summary": "string",
      "focus": "string",
      "source": "ai"
    },
    "summary_status": "none",
    "ai_summary": true,
    "generated_at": "2026-10-06T05:30:00.000Z",
    "acknowledged_at": "2026-10-06T05:30:00.000Z",
    "show": 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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/me/briefing/summary

The briefing’s AI lines (grounded in its facts, cached once made)

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

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.dayrequired: string
data.rolerequired: "agent" | "manager"
data.contentrequired: object
data.content.versionrequired: 1
data.content.rolerequired: "agent" | "manager"
data.content.dayrequired: string
data.content.day_labelrequired: string
data.content.headlinerequired: string
data.content.statsrequired: array of object
data.content.sectionsrequired: array of object
data.summaryrequired: object or null
data.summary.summaryrequired: string
data.summary.focusrequired: string
data.summary.sourcerequired: "ai" | "fallback"
data.summary_statusrequired: "none" | "ready" | "fallback" | "unavailable" | "off"
data.ai_summaryrequired: boolean
data.generated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.acknowledged_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.showrequired: boolean
Open the “your day” modal: not started from yet today, something to show.
data.creditsrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/me/briefing/summary' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "day": "string",
    "role": "agent",
    "content": {
      "version": 1,
      "role": "agent",
      "day": "string",
      "day_label": "string",
      "headline": "string",
      "stats": [
        {
          "key": "string",
          "label": "string",
          "value": "string",
          "tone": "danger",
          "hint": "string"
        }
      ],
      "sections": [
        {
          "key": "string",
          "title": "string",
          "items": [
            {
              "id": null,
              "ref": null,
              "title": null,
              "detail": null,
              "link": null,
              "tone": null
            }
          ],
          "more": 0,
          "link": "string"
        }
      ]
    },
    "summary": {
      "summary": "string",
      "focus": "string",
      "source": "ai"
    },
    "summary_status": "none",
    "ai_summary": true,
    "generated_at": "2026-10-06T05:30:00.000Z",
    "acknowledged_at": "2026-10-06T05:30:00.000Z",
    "show": true,
    "credits": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
402 CREDITS_EXHAUSTED — the AI wallet is empty or the monthly AI limit is reached.
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.
503 NOT_CONFIGURED — AI is not set up on this PropZolo deployment (ask your PropZolo admin).

GET/v1/settings/briefing

The daily briefing settings of the company

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

Response · 200

datarequired: BriefingSettingsView
metarequired: object

Request

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

Response example

{
  "data": {
    "enabled": true,
    "push": true,
    "email": true,
    "ai_summary": true,
    "stuck_deal_days": 3,
    "lead_minutes": 0,
    "push_on_plan": 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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/settings/briefing

Change the daily briefing settings (push and email are opt-in)

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

Request body

enabled: boolean
push: boolean
email: boolean
ai_summary: boolean
stuck_deal_days: integer
lead_minutes: integer

Response · 200

datarequired: BriefingSettingsView
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/settings/briefing' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"push":true,"email":true,"ai_summary":true,"stuck_deal_days":3,"lead_minutes":0}'

Response example

{
  "data": {
    "enabled": true,
    "push": true,
    "email": true,
    "ai_summary": true,
    "stuck_deal_days": 3,
    "lead_minutes": 0,
    "push_on_plan": 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.
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.