API reference

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/askAsk PropZolo: a question in plain words → a validated query, the result and a grounded answer
• GET/v1/ai/ask/catalogueWhat the caller can ask about: entities, fields (with options) and reports, for the manual builder
• GET/v1/ai/ask/historyThe caller’s questions, newest first
• GET/v1/ai/ask/history/{id}One of the caller’s questions, its result run again now
• POST/v1/ai/ask/runRun an edited plan (the chips) without the model
• POST/v1/ai/ask/smart-listSave a lead or contact question as a smart list (a saved view; its period becomes fixed dates)
• POST/v1/ai/conversation-summarySummarise a conversation: needs, facts, open questions, next steps, sentiment
• POST/v1/ai/feedbackRate an AI result (helpful or not)
• GET/v1/ai/historyRecent AI actions (the caller’s own; the whole company’s for AI admins)
• GET/v1/ai/inventoryThe inventory inbox: parsed broker posts, newest first
• POST/v1/ai/inventoryParse a pasted or forwarded broker message into review cards
• GET/v1/ai/inventory/{id}One inventory post with its cards
• POST/v1/ai/inventory/{id}/cards/{index}Accept a card (creates a private listing or a lead; matching starts) or reject it
• POST/v1/ai/leads/{id}/explain"Explain this lead": why it is hot or cold, with evidence, and the next best action
• POST/v1/ai/leads/{id}/requirement"Fill from notes": requirement proposals from the lead’s notes (or the given text)
• POST/v1/ai/leads/{id}/requirement/applyApply the accepted proposals to the lead (an ordinary lead update plus an AI timeline entry)
• GET/v1/ai/leads/{id}/scoreA lead’s score with its reasons
• POST/v1/ai/leads/{id}/scoreRecompute a lead’s score now (scores also follow lead events and a nightly pass)
• POST/v1/ai/leads/{id}/summaryAI summary of a lead for the agent opening it
• POST/v1/ai/listing-copyTitle, description, highlights and a WhatsApp caption from the listing’s own facts
• POST/v1/ai/reply-draftDraft the next reply in a conversation (English, Hindi or Hinglish; template-only when the window is closed)
• GET/v1/ai/reportsThe caller’s saved reports and the team’s
• POST/v1/ai/reportsSave a question as a report definition (it must run for its author)
• GET/v1/ai/reports/{id}A saved report with its result, run now with the viewer’s scope
• PATCH/v1/ai/reports/{id}Rename, pin, share or chart a saved report (its author; team reports also settings.company)
• DELETE/v1/ai/reports/{id}Delete a saved report
• POST/v1/ai/requirement-extractA requirement from free text (an enquiry, a chat) with per-field confidence and evidence
• POST/v1/ai/search/leadsPlain-words lead search → a validated filter (editable chips) for the leads list
• POST/v1/ai/segmentsA natural-language audience → a proposed lead filter with its count (F-02 AI Segment)
• PATCH/v1/ai/settingsChange the company AI settings (switch, monthly credit cap, intent signals, voice)
• GET/v1/ai/statusWhether AI features can run for the caller, and why not
• GET/v1/ai/usageAI usage: credits this month, by feature and per day, the wallet and the settings
• GET/v1/me/briefingThe caller’s briefing for today (built on first open, refreshed when half an hour old)
• POST/v1/me/briefing/ack“Start my day”: the briefing modal stays closed for the rest of the day
• POST/v1/me/briefing/summaryThe briefing’s AI lines (grounded in its facts, cached once made)
• GET/v1/settings/briefingThe daily briefing settings of the company
• PATCH/v1/settings/briefingChange the daily briefing settings (push and email are opt-in)

AI agents

The WhatsApp AI agent: settings, the per-number switch off → shadow → live behind the agent check, approved facts, KPIs, inbox drafts and hand-offs.

• GET/v1/ai/agent-factsApproved fact sheets the agent may quote (per project or company-wide)
• POST/v1/ai/agent-factsAdd an approved fact (offers count only from here)
• PATCH/v1/ai/agent-facts/{id}Edit an approved fact (re-approved by the editor)
• DELETE/v1/ai/agent-facts/{id}Archive a fact (the agent no longer sees it)
• GET/v1/ai/agent/conversationsThe agent’s status for the given conversations (only those the member can see)
• GET/v1/ai/agent/conversations/{id}The agent in one conversation: status, what it noted, drafts to approve, recent turns
• POST/v1/ai/agent/conversations/{id}/releaseHand the chat back to the agent (it answers the customer’s next message)
• POST/v1/ai/agent/conversations/{id}/reopenReopen a conversation the agent closed as disqualified (never an opt-out)
• POST/v1/ai/agent/conversations/{id}/take-overTake the chat from the agent (it stops replying and only drafts)
• POST/v1/ai/agent/drafts/{id}/approveSend an agent draft — as written, or with your edits (sent as yours)
• POST/v1/ai/agent/drafts/{id}/rejectDiscard an agent draft
• GET/v1/ai/agentsThe company’s WhatsApp AI agents with their settings and numbers
• POST/v1/ai/agentsCreate a WhatsApp AI agent (every number starts off; shadow mode first)
• GET/v1/ai/agents/optionsWhat an agent’s settings can point at: WhatsApp numbers, templates, sendable assets, projects
• GET/v1/ai/agents/overviewKPIs: first response, reply rate, qualified %, visits, hand-off and edit rates, opt-outs, credits
• GET/v1/ai/agents/{id}One WhatsApp AI agent
• PATCH/v1/ai/agents/{id}Change an agent’s settings (bumps its settings version: the agent check must pass again to go live)
• DELETE/v1/ai/agents/{id}Archive an agent (its numbers are switched off; history stays)
• PUT/v1/ai/agents/{id}/channelsPut a WhatsApp number under the agent: off · shadow · live
• DELETE/v1/ai/agents/{id}/channels/{accountId}Take a WhatsApp number away from the agent
• POST/v1/ai/agents/{id}/evalRun the agent check: the offline eval gates on the agent’s current settings (no AI credits)

AI assistants

Claude, ChatGPT and other assistants through MCP: consent, connections, drafts waiting for approval, the call log and the company policy with its kill switch.

• GET/v1/ai-assistants/draftsAssistant requests waiting for approval
• POST/v1/ai-assistants/drafts/{id}/approveApprove an assistant’s request
• POST/v1/ai-assistants/drafts/{id}/rejectReject an assistant’s request
• GET/v1/me/ai-assistantsThe assistants the caller connected
• GET/v1/me/ai-assistants/activityWhat the caller’s assistants did
• DELETE/v1/me/ai-assistants/{id}Disconnect one of the caller’s assistants
• POST/v1/oauth/consentApprove or deny an assistant’s request to connect
• GET/v1/settings/ai-assistantsAI assistant settings
• PATCH/v1/settings/ai-assistantsChange the AI assistant settings
• GET/v1/settings/ai-assistants/activityThe assistant call log of the company
• PUT/v1/settings/ai-assistants/clients/{id}Allow or block an assistant client
• GET/v1/settings/ai-assistants/connectionsEvery member’s connected assistants
• DELETE/v1/settings/ai-assistants/connections/{id}Disconnect a member’s assistant
• PUT/v1/settings/ai-assistants/members/{id}A member’s assistant autonomy (or off)
• POST/v1/settings/ai-assistants/stopKill switch: stop every assistant now

AI voice agent

Calls from declared A2P numbers in Hindi, English or Hinglish (N-01): new-enquiry callbacks within 60 s, missed calls, visit confirmations and feedback, grounded on the lead and inventory, with live transfer to a member; settings, the live / recent monitor and transcripts.

• GET/v1/calls/{id}/voice-agentThe AI conversation of a call
• GET/v1/settings/voice-agentAI voice agent settings
• PUT/v1/settings/voice-agentSave the AI voice agent settings
• GET/v1/voice-agent/callsAI voice calls
• POST/v1/voice-agent/callsAsk the agent to call a lead
• GET/v1/voice-agent/calls/{id}An AI voice call with its transcript
• POST/v1/voice-agent/calls/{id}/cancelCancel a call that has not rung
• GET/v1/voice-agent/statsToday’s AI voice numbers

Account

The signed-in person: profile, email and phone changes, password, two-step verification and sessions.

• GET/v1/me/profileMy profile
• PATCH/v1/me/profileUpdate my name or languages
• POST/v1/me/profile/emailChange my email
• POST/v1/me/profile/email/confirmConfirm a new email
• POST/v1/me/profile/phoneChange my mobile number
• POST/v1/me/profile/phone/verifyConfirm a new mobile number
• POST/v1/me/profile/photoStart a profile photo upload
• PUT/v1/me/profile/photoUse an uploaded photo
• DELETE/v1/me/profile/photoRemove my photo
• GET/v1/me/securityMy sign-in security
• POST/v1/me/security/backup-codesNew backup codes
• POST/v1/me/security/passwordSet or change my password
• POST/v1/me/security/two-factor/disableTurn off two-step verification
• GET/v1/me/sessionsWhere I’m signed in
• POST/v1/me/sessions/revoke-othersSign out everywhere else
• DELETE/v1/me/sessions/{id}Sign out one session
• POST/v1/me/step-upConfirm it’s me

Accountability

Follow-up discipline scores (0–100) per member with explained components, trends, the team ranking and the optional rotation eligibility.

• GET/v1/accountability/members/{id}A member’s accountability score
• POST/v1/accountability/recomputeRecompute today’s scores now
• GET/v1/accountability/teamTeam accountability ranking
• GET/v1/me/accountabilityMy accountability score

Ad conversions

Qualified leads, site visits and bookings of ad leads sent back to Meta and Google Ads: settings, test events, the delivery log and objections.

• GET/v1/ad-conversionsAd conversions settings
• GET/v1/ad-conversions/deliveriesThe conversion delivery log
• POST/v1/ad-conversions/deliveries/{id}/retrySend a failed conversion again
• GET/v1/ad-conversions/google/oauth/callbackGoogle sign-in callback
• GET/v1/ad-conversions/google/oauth/startStart the Google sign-in for Ads
• PATCH/v1/ad-conversions/google/{id}Change the Google Ads conversions settings
• GET/v1/ad-conversions/google/{id}/accountsGoogle Ads accounts and conversion actions
• POST/v1/ad-conversions/metaConnect the Meta Conversions API
• PATCH/v1/ad-conversions/meta/{id}Change the Meta Conversions API settings
• POST/v1/ad-conversions/meta/{id}/whatsapp-datasetsLink the datasets of WhatsApp Business Accounts
• PUT/v1/ad-conversions/milestonesSet which statuses count as milestones
• POST/v1/ad-conversions/{id}/retry-failedSend failed conversions again
• POST/v1/ad-conversions/{id}/testSend a test conversion
• GET/v1/contacts/{id}/ads-measurementWhether the person’s ad conversions may be shared
• PUT/v1/contacts/{id}/ads-measurementRecord or lift an objection to ad measurement

Approvals

Human approvals: workflow steps and approval chains of guarded actions (exports, deletes, discounts, rent below the floor, brokerage, stage gates) — levels, holds, bulk decisions, signed links, WhatsApp, the policies.

• GET/v1/approvalsApproval requests for me
• POST/v1/approvals/bulk-decideApprove or reject many requests
• GET/v1/approvals/by-token/{token}An approval request by its signed link
• POST/v1/approvals/by-token/{token}/decideApprove or reject by the signed link
• GET/v1/approvals/requestsApprovals I asked for
• GET/v1/approvals/requests/{id}An approval chain
• POST/v1/approvals/requests/{id}/cancelWithdraw my request
• GET/v1/approvals/whatsappMy approval requests on WhatsApp
• PUT/v1/approvals/whatsappGet approval requests on WhatsApp
• GET/v1/approvals/{id}An approval request
• POST/v1/approvals/{id}/decideApprove, approve with edits or reject
• POST/v1/approvals/{id}/holdPut a request on hold
• POST/v1/approvals/{id}/resumeResume a request on hold
• GET/v1/settings/approval-policiesApproval policies
• PUT/v1/settings/approval-policiesChange the approval policies

Assignment

Lead routing: rules and their simulator, routing profiles, the assignment log, pools, SLA, staff exit.

• GET/v1/assignment-logsThe assignment log
• GET/v1/assignment-rulesAssignment rules in evaluation order
• POST/v1/assignment-rulesCreate an assignment rule
• GET/v1/assignment-rules/membersMembers with their routing profile and today’s load
• PATCH/v1/assignment-rules/members/{id}Change a member’s routing profile
• GET/v1/assignment-rules/optionsWhat the rule editor offers
• POST/v1/assignment-rules/reorderChange the order of the rules
• GET/v1/assignment-rules/settingsCompany-wide routing settings
• PUT/v1/assignment-rules/settingsChange the routing settings
• POST/v1/assignment-rules/simulateWho would get this lead?
• GET/v1/assignment-rules/staff-exit/{memberId}What a leaving member still holds
• POST/v1/assignment-rules/staff-exit/{memberId}Hand over a leaving member’s work
• POST/v1/assignment-rules/staff-exit/{memberId}/previewPreview a hand-over
• GET/v1/assignment-rules/{id}An assignment rule
• PATCH/v1/assignment-rules/{id}Change an assignment rule
• DELETE/v1/assignment-rules/{id}Delete an assignment rule
• GET/v1/poolsLead pools with their counts
• PUT/v1/poolsSave the pool definitions
• POST/v1/pools/{id}/claimClaim a lead from a pool
• POST/v1/pools/{id}/giveGive members leads from a pool
• GET/v1/pools/{id}/leadsLeads waiting in a pool
• GET/v1/sla/digestA day of first responses
• GET/v1/sla/leadsUnanswered leads against their SLA
• GET/v1/sla/settingsFirst-response SLA settings
• PUT/v1/sla/settingsChange the first-response SLA

Attendance

Punch in / out with geofence and selfie (offline-safe, tamper signals), breaks, live location on duty with consent, the team view, corrections, the attendance register and field report, settings and sites.

• PUT/v1/attendance/daysCorrect a member’s day
• GET/v1/attendance/exportExport the register or the field report as CSV
• GET/v1/attendance/field-reportField report
• POST/v1/attendance/location-consentAgree to share live location while on duty
• DELETE/v1/attendance/location-consentStop sharing live location
• POST/v1/attendance/locationsUpload live-location points
• GET/v1/attendance/members/{id}/days/{date}A member’s day with every punch
• GET/v1/attendance/members/{id}/trackA member’s on-duty route for a day
• POST/v1/attendance/punchesPunch in, out, or start / end a break
• GET/v1/attendance/punches/{id}/selfieA punch selfie (short-lived link)
• GET/v1/attendance/registerAttendance register
• POST/v1/attendance/selfiesUpload a punch selfie
• GET/v1/attendance/settingsAttendance settings
• PUT/v1/attendance/settingsChange the attendance settings
• GET/v1/attendance/sitesOffices and sites members punch at
• POST/v1/attendance/sitesAdd an attendance site
• PATCH/v1/attendance/sites/{id}Change an attendance site
• DELETE/v1/attendance/sites/{id}Remove an attendance site
• GET/v1/attendance/teamWho is in today
• GET/v1/attendance/todayMy attendance today

Automation tools

Zapier, Make and Pabbly: REST-hook subscriptions and polling triggers for API keys.

• POST/v1/actions/upsert_contactCreate or update a contact
• POST/v1/actions/upsert_leadCreate or update a lead
• GET/v1/hooksThe API key’s REST hooks
• POST/v1/hooksSubscribe a REST hook (Zapier, Make, Pabbly)
• DELETE/v1/hooks/{id}Unsubscribe a REST hook
• GET/v1/searches/contactFind contacts (automation search)
• GET/v1/searches/leadFind leads (automation search)
• GET/v1/triggersTriggers for automation tools
• GET/v1/triggers/{trigger}Poll a trigger

Automations

Workflows (trigger → conditions → actions, delays, waits, goals), versions, dry runs, run logs and recipes.

• GET/v1/workflowsWorkflows
• POST/v1/workflowsCreate a workflow (draft)
• GET/v1/workflows/catalogueBuilder catalogue
• GET/v1/workflows/optionsBuilder pickers
• GET/v1/workflows/recipesRecipe gallery
• POST/v1/workflows/recipes/{key}/installInstall a recipe
• POST/v1/workflows/validateValidate an unsaved graph
• GET/v1/workflows/{id}A workflow
• PATCH/v1/workflows/{id}Save the draft
• DELETE/v1/workflows/{id}Archive a workflow
• POST/v1/workflows/{id}/dry-runTest with a record
• POST/v1/workflows/{id}/pausePause a workflow
• POST/v1/workflows/{id}/publishPublish the draft
• POST/v1/workflows/{id}/resumeResume a workflow
• GET/v1/workflows/{id}/runsRuns of a workflow
• GET/v1/workflows/{id}/runs/{runId}A run with its steps
• GET/v1/workflows/{id}/statsRuns per day
• POST/v1/workflows/{id}/validateValidate the draft
• GET/v1/workflows/{id}/versionsPublished versions

Bank reconciliation

Bank statements (CSV / Excel, per bank) matched to rent UTR claims, deal receipts and booking payments by UTR, amount and date (N-10): clear matches confirmed by rule, near ones reviewed; never applied twice.

• GET/v1/bank-statementsImported statements
• POST/v1/bank-statementsImport a bank statement
• POST/v1/bank-statements/{id}/rematchMatch the open credits again
• GET/v1/bank-transactionsBank lines and the review queue
• POST/v1/bank-transactions/{id}/ignoreSet a bank line aside
• POST/v1/bank-transactions/{id}/matchConfirm or link a match
• GET/v1/settings/bank-reconciliationThe reconciliation rule
• PUT/v1/settings/bank-reconciliationSave the reconciliation rule
• GET/v1/settings/bank-reconciliation/mailboxThe bank statement mailbox
• PUT/v1/settings/bank-reconciliation/mailboxSet up the bank statement mailbox

Billing

The PropZolo subscription (plans, seats, checkout, proration), GST invoices, prepaid wallets, the onboarding checklist and support-access grants.

• GET/v1/billingPlan, seats and payment status
• POST/v1/billing/checkoutStart a paid subscription
• GET/v1/billing/invoicesGST invoices and credit notes
• GET/v1/billing/invoices/{id}/documentPrintable invoice (HTML)
• GET/v1/billing/plansPlans on sale
• POST/v1/billing/subscription/cancelCancel at the period end
• POST/v1/billing/subscription/changeChange plan, seats or billing cycle
• GET/v1/billing/walletsWallet balances and rate card
• GET/v1/billing/wallets/transactionsWallet ledger
• PATCH/v1/billing/wallets/{kind}Set the low-balance alert
• POST/v1/billing/wallets/{kind}/top-upTop up a wallet
• GET/v1/onboardingOnboarding checklist
• PATCH/v1/onboardingHide or show the checklist
• GET/v1/support-accessSupport-access grants and sessions
• POST/v1/support-accessLet PropZolo support in
• POST/v1/support-access/{id}/revokeRevoke support access

Bookings

• GET/v1/bookingsBookings you can see, newest first
• POST/v1/bookingsBook the unit of a cost sheet the customer accepted (the unit is booked at once)
• GET/v1/bookings/receipts/by-token/{token}A booking receipt PDF by its signed portal link
• GET/v1/bookings/{id}One booking: the form, the frozen cost sheet, the schedule, the approval
• PATCH/v1/bookings/{id}Change a draft booking: payment plan, booking date, loan, notes
• GET/v1/bookings/{id}/allotment-letterThe allotment letter as PDF (a DRAFT preview until the booking is confirmed)
• PUT/v1/bookings/{id}/applicantsReplace the applicants (PAN stored encrypted, only the last four of Aadhaar kept)
• POST/v1/bookings/{id}/applicants/{applicantId}/reveal-panAn applicant’s full PAN (audited)
• GET/v1/bookings/{id}/documentsKYC documents of a booking
• POST/v1/bookings/{id}/documentsAttach an uploaded KYC document
• POST/v1/bookings/{id}/documents/uploadA presigned private upload for a KYC document
• GET/v1/bookings/{id}/documents/{documentId}A 60-second signed download link (audited)
• DELETE/v1/bookings/{id}/documents/{documentId}Remove a KYC document from a draft booking
• PUT/v1/bookings/{id}/partnerCredit a booking not yet confirmed to a channel partner, change or remove the credit (audited, with a reason)
• POST/v1/bookings/{id}/submitSend a complete booking to its approval chain (the company owner confirms at once)
• POST/v1/bookings/{id}/withdrawWithdraw a booking not yet confirmed (the unit returns to sale)
• PATCH/v1/payment-plans/{id}Change a payment plan or switch it off (confirmed bookings keep their schedule)
• GET/v1/projects/{id}/payment-plansPayment plans of a project
• POST/v1/projects/{id}/payment-plansAdd a payment plan (milestones add up to exactly 100 %)

Broker network

The co-broking network (N-03): the network profile with RERA / KYC badges and trust signals, the directory, circles, masked shares of listings and requirements with availability checks, matches, co-broke deals with frozen split terms, deal rooms and client registration locks.

• GET/v1/network/availability-checksAvailability checks
• POST/v1/network/availability-checks/{id}/answerAnswer an availability check
• POST/v1/network/circle-memberships/{id}Answer an invitation or a join request, leave or remove
• GET/v1/network/circlesCircles
• POST/v1/network/circlesStart a circle
• POST/v1/network/circles/{id}/membersInvite a company, or ask to join
• GET/v1/network/co-brokesCo-broke deals
• POST/v1/network/co-brokesAsk to co-broke a shared item
• GET/v1/network/co-brokes/{id}A deal room
• POST/v1/network/co-brokes/{id}/actionsMove a co-broke
• POST/v1/network/co-brokes/{id}/disputeRaise or settle a dispute
• POST/v1/network/co-brokes/{id}/documentsAdd an uploaded document to the deal room
• POST/v1/network/co-brokes/{id}/documents/uploadsUpload URL for a deal room document
• GET/v1/network/co-brokes/{id}/documents/{documentId}/downloadDownload a deal room document
• POST/v1/network/co-brokes/{id}/esignE-sign the agreed terms (optional)
• POST/v1/network/co-brokes/{id}/esign/signOpen this broker’s signing page
• POST/v1/network/co-brokes/{id}/link-dealLink the company’s own deal
• POST/v1/network/co-brokes/{id}/messagesWrite in the deal room
• POST/v1/network/co-brokes/{id}/registrationsRegister a client with the sharer
• GET/v1/network/directoryThe broker directory
• GET/v1/network/feedShares from the network
• GET/v1/network/matchesMatches across the network
• GET/v1/network/profileThe company’s network profile
• PUT/v1/network/profileSet up or edit the network profile
• POST/v1/network/profile/kycSubmit KYC for verification
• POST/v1/network/profile/kyc/uploadsUpload URL for the KYC document
• POST/v1/network/registrations/{id}Release, reject or decide a registration
• GET/v1/network/sharesWhat the company shares
• POST/v1/network/sharesShare a listing or a requirement (masked)
• POST/v1/network/shares/{id}/availabilityAsk whether a shared item is still available
• POST/v1/network/shares/{id}/statusConfirm, pause, resume, revoke or close a share
• GET/v1/network/suggestionsNetwork shares for your unshared leads and listings

Calendar sync

Members’ own Google / Microsoft 365 calendars: PropZolo’s calendar with visits and meetings, free/busy blocks for the visit scheduler (times only), and disconnect.

• GET/v1/calendarMy calendar sync
• PATCH/v1/calendarWhat goes into my calendar
• DELETE/v1/calendarDisconnect my calendar
• GET/v1/calendar/busyA member’s busy times
• POST/v1/calendar/syncSync my calendar now
• GET/v1/calendar/{provider}/oauth/callbackCalendar sign-in callback
• GET/v1/calendar/{provider}/oauth/startConnect my calendar: the provider’s sign-in

Call insights

Call intelligence: summary, outcome and hot signal, objections with quotes, promised call-backs proposed as tasks, requirement fields proposed for review, QA scorecards on the company rubric, overrides, trends and the coaching queue.

• GET/v1/call-qa/coachingThe coaching queue
• GET/v1/call-qa/scorecardsQA scorecards
• GET/v1/call-qa/trendsQA trends
• GET/v1/calls/{id}/insightsA call’s insights
• POST/v1/calls/{id}/insights/analyseAnalyse a call now
• POST/v1/calls/{id}/insights/commitmentsTurn promised call-backs into tasks
• POST/v1/calls/{id}/insights/proposalApply or dismiss the requirement fields heard on a call
• POST/v1/calls/{id}/insights/reviewReview a call’s QA scorecard
• GET/v1/settings/call-insightsCall-insights settings
• PATCH/v1/settings/call-insightsChange the call-insights settings

Call list

Who to call today: the ranked list with reasons (call now, later today, done), skips and snoozes, a manager’s view of a member’s list, and the list’s settings.

• GET/v1/call-list/members/{id}A member’s call list today
• GET/v1/me/call-listWho to call today
• POST/v1/me/call-list/actionsSkip or snooze a lead on my call list
• DELETE/v1/me/call-list/actions/{id}Undo a skip or snooze
• GET/v1/settings/call-plannerCall list and accountability settings
• PATCH/v1/settings/call-plannerChange call list and accountability settings

Calling queue

Who to call next — the Autopilot dial brain with calling hours, cool-downs and caps.

• GET/v1/mobile/queueWho to call next (Autopilot)
• POST/v1/mobile/queue/skipNot now: skip a lead for a while

Calls

The call log, call cards, outcomes, analytics, agent phones, daily targets and call-tracking settings.

• GET/v1/callsThe call log
• GET/v1/calls/analyticsCall analytics
• GET/v1/calls/analytics/agents/{memberId}One agent’s calls (agent drawer)
• POST/v1/calls/click-to-callCall a lead through cloud telephony
• GET/v1/calls/cloudCan I call through cloud telephony?
• GET/v1/calls/devicesAgent phones
• PUT/v1/calls/devices/{memberId}/trackingSwitch call tracking for a member
• POST/v1/calls/manualRecord a call placed without call tracking
• GET/v1/calls/membersMembers for the agent filter
• GET/v1/calls/pendingMy calls waiting for their outcome
• PUT/v1/calls/phones/{id}/work-simsLock the work SIMs of a phone
• GET/v1/calls/settingsCall-tracking settings
• PATCH/v1/calls/settingsChange call-tracking settings
• GET/v1/calls/targetsMy daily targets, streak and rank
• PUT/v1/calls/targetsSet daily call targets
• GET/v1/calls/targets/boardToday’s leaderboard
• GET/v1/calls/{id}One call
• POST/v1/calls/{id}/assistLive call assist
• POST/v1/calls/{id}/leadAdd an unknown caller as a lead
• POST/v1/calls/{id}/outcomeTag what happened on a call
• GET/v1/calls/{id}/recordingPlay a call recording

Campaign spend

Spend entries per campaign and source per period, behind cost per lead / visit / deal and source ROI.

• GET/v1/campaignsCampaigns and their spend
• POST/v1/campaignsRecord campaign spend
• PATCH/v1/campaigns/{id}Change a campaign’s spend or period
• DELETE/v1/campaigns/{id}Delete a campaign no lead came from

Campaigns

Follow-up plans (steps, business-day delays, enrolments, pause rules, step analytics) and broadcasts (audience snapshot, approval, throttled sending, stats).

• GET/v1/broadcastsBroadcasts
• POST/v1/broadcastsDraft a broadcast
• GET/v1/broadcasts/sendersSenders a broadcast can use
• GET/v1/broadcasts/{id}A broadcast
• PATCH/v1/broadcasts/{id}Edit a broadcast draft
• DELETE/v1/broadcasts/{id}Delete a broadcast draft
• POST/v1/broadcasts/{id}/approveApprove and launch
• POST/v1/broadcasts/{id}/buildBuild the audience snapshot
• POST/v1/broadcasts/{id}/cancelCancel a broadcast
• POST/v1/broadcasts/{id}/complianceRun the AI Compliance Check
• POST/v1/broadcasts/{id}/compliance/overrideOverride an AI-review failure
• GET/v1/broadcasts/{id}/exportExport the recipients as CSV
• POST/v1/broadcasts/{id}/launchSend now or schedule
• POST/v1/broadcasts/{id}/pausePause a broadcast
• POST/v1/broadcasts/{id}/personalizeWrite the AI personal values
• POST/v1/broadcasts/{id}/personalize/previewPreview AI personal values for a few recipients
• GET/v1/broadcasts/{id}/recipientsRecipients of a broadcast
• POST/v1/broadcasts/{id}/rejectSend back for changes
• POST/v1/broadcasts/{id}/resumeResume a broadcast
• POST/v1/broadcasts/{id}/submitAsk for approval
• GET/v1/sequencesFollow-up plans
• POST/v1/sequencesCreate a follow-up plan
• GET/v1/sequences/enrollmentsA lead’s follow-up plans
• PATCH/v1/sequences/enrollments/{id}Pause, resume or remove an enrolment
• GET/v1/sequences/{id}A follow-up plan
• PATCH/v1/sequences/{id}Edit a follow-up plan
• DELETE/v1/sequences/{id}Archive a follow-up plan
• POST/v1/sequences/{id}/activateActivate a follow-up plan
• GET/v1/sequences/{id}/analyticsStep analytics of a follow-up plan
• GET/v1/sequences/{id}/enrollmentsEnrolments of a follow-up plan
• POST/v1/sequences/{id}/enrollmentsEnrol leads in a follow-up plan
• POST/v1/sequences/{id}/pausePause a follow-up plan

Channel partners

• GET/v1/cp-disputesThe dispute queue: open first, oldest first
• GET/v1/cp-disputes/{id}A dispute with both sides’ evidence and the suggested outcome
• POST/v1/cp-disputes/{id}/decisionDecide a dispute (final; the reason is kept in the audit trail)
• POST/v1/cp-disputes/{id}/evidenceAdd a note to a dispute’s evidence (a member)
• GET/v1/cp-registrationsClient registrations by partners (portal and walk-in), newest first
• POST/v1/cp-registrations/{id}/decisionAccept or reject a pending registration (not one in dispute — decide the dispute)
• POST/v1/partner-agreements/{id}/cancelCancel a signing request that is still open
• GET/v1/partner-agreements/{id}/downloadA short-lived link to the agreement (the signed copy once signed)
• GET/v1/partner-collateralThe collateral library (published and archived)
• POST/v1/partner-collateralPublish a collateral item (an uploaded file or an https link)
• POST/v1/partner-collateral/uploadsUpload a collateral file (PDF, image or video)
• PATCH/v1/partner-collateral/{id}Edit, archive or republish a collateral item
• GET/v1/partner-collateral/{id}/downloadA short-lived link to a collateral file (partners: published items only)
• GET/v1/partner-documents/{id}/downloadA short-lived link to a partner’s document (members, or the partner itself)
• POST/v1/partner-documents/{id}/reviewVerify or reject a partner’s KYC document
• POST/v1/partner-kyc-shares/{id}/decisionAccept or reject a shared KYC document
• GET/v1/partnersChannel partners, with onboarding status and live registrations
• POST/v1/partnersAdd a partner firm (pending until approved)
• GET/v1/partners/{id}A partner with its onboarding checklist, documents and agreement
• PATCH/v1/partners/{id}Update a partner’s profile and KYC details
• POST/v1/partners/{id}/agreementSend the channel-partner agreement for e-signature
• POST/v1/partners/{id}/decisionApprove, reject, suspend or reinstate a partner
• POST/v1/partners/{id}/documentsRegister an uploaded KYC document
• POST/v1/partners/{id}/documents/uploadsUpload a KYC document (PDF or photo) for a partner
• POST/v1/partners/{id}/inviteInvite the partner to the portal (a link to share once)
• GET/v1/partners/{id}/kyc-sharesKYC a partner shared from other builders
• GET/v1/settings/partnersPartner settings: lock windows, alerts, the price toggle and onboarding rules
• PATCH/v1/settings/partnersChange the partner settings

Channel-partner brokerage

• GET/v1/cp-brokerage/accrualsBrokerage per partner booking, with the collection gate
• GET/v1/cp-brokerage/invoicesPartners’ brokerage invoices and their payouts
• POST/v1/cp-brokerage/invoices/{id}/cancelCancel an unpaid partner invoice (its payout too; brokerage back to eligible)
• GET/v1/cp-brokerage/invoices/{id}/downloadA short-lived link to the invoice PDF (finance, or the partner who raised it)
• POST/v1/cp-brokerage/recalculateBring every partner booking’s brokerage up to date (slabs, collections, cancellations)
• GET/v1/cp-brokerage/schemesBrokerage schemes (active first)
• POST/v1/cp-brokerage/schemesAdd a brokerage scheme (a project’s, or the company default)
• PATCH/v1/cp-brokerage/schemes/{id}Change or archive a scheme (invoiced and paid brokerage never changes)
• GET/v1/cp/earningsThe partner’s brokerage by booking, balances and ledger
• GET/v1/cp/invoicesThe partner’s invoices and their payment
• POST/v1/cp/invoicesRaise a GST invoice for eligible brokerage (and redeem the incentive wallet)
• GET/v1/cp/invoices/draftWhat the partner can invoice now: eligible bookings and the incentive balance
• GET/v1/partners/{id}/ledgerA partner’s ledger: brokerage owed, the incentive wallet and every line

Collections

Builder collections on bookings: construction stages, demand letters and reminders, receipts with 194-IA TDS, late interest, ledger, ageing, cancellation, refunds and transfers.

• POST/v1/booking-demands/{id}/cancelCancel an open demand raised in error (its instalments can be demanded again)
• GET/v1/booking-demands/{id}/letterThe demand letter as PDF
• POST/v1/booking-instalments/{id}/pay-linkThe buyer’s signed pay link of an open instalment (UPI to the collection account, then the UTR)
• POST/v1/booking-interest/{id}/decideCharge late interest (it joins the next demand) or waive it with a reason
• POST/v1/booking-receipts/{id}/bounceA payment bounced or was entered in error: its allocations are reversed
• POST/v1/booking-receipts/{id}/claimConfirm a UPI payment the buyer reported on the pay link (it is numbered and allocated) or reject it
• POST/v1/booking-receipts/{id}/clearA cheque / DD was realised
• GET/v1/booking-receipts/{id}/pdfThe receipt or refund voucher as PDF
• POST/v1/booking-receipts/{id}/refund-paidA refund voucher was paid out
• POST/v1/booking-receipts/{id}/tdsRecord the Form 16B for the TDS on a payment (the TDS then counts as paid)
• POST/v1/bookings/{id}/cancelCancel an allotted booking: forfeiture kept, the rest refunded, the unit back on sale, brokerage reversed
• GET/v1/bookings/{id}/collectionsA booking’s schedule, demands, receipts, interest, TDS, transfers and customer ledger
• POST/v1/bookings/{id}/demandsRaise a demand letter (default: every instalment due within 30 days and not demanded yet)
• POST/v1/bookings/{id}/milestone-datesThe agreement was signed / possession offered: its instalments fall due and are demanded
• POST/v1/bookings/{id}/receiptsRecord a buyer’s payment (and the TDS they deducted); it settles the oldest demanded instalments first
• PUT/v1/bookings/{id}/stamp-valueRecord the registered stamp-duty value (194-IA tests the higher of it and the consideration)
• POST/v1/bookings/{id}/transferTransfer an allotted booking to new buyers (endorsement), with an optional transfer fee
• GET/v1/collectionsAgeing of booking instalments, bookings with money outstanding and payments awaiting Form 16B
• GET/v1/collections/settingsDemand days, reminder days, late interest, forfeiture and buyer messages
• PUT/v1/collections/settingsChange the collections settings (audited)
• GET/v1/projects/{id}/completionCompletion / occupancy certificate dates of a project and its towers
• PUT/v1/projects/{id}/completionRecord (or clear) the completion / occupancy certificate date of a tower or the whole project
• GET/v1/projects/{id}/construction-stagesConstruction stages certified for a project
• POST/v1/projects/{id}/construction-stagesCertify a stage: every allotted booking’s instalments linked to it fall due and are demanded
• GET/v1/projects/{id}/construction-stages/previewHow many allotted bookings (and instalments) certifying a stage would demand — before certifying

Commissions

Commission payouts to members and co-brokers (records; TDS and invoices in Phase 2).

• GET/v1/commission-payoutsList commission payouts
• POST/v1/commission-payoutsRecord a payout
• PATCH/v1/commission-payouts/{id}Edit, approve, hold or cancel a payout
• POST/v1/deals/{id}/payoutsPayouts from the splits

Company

Company profile, RERA & GST, branding, business hours & holidays and the security policy.

• GET/v1/companyCompany profile
• PATCH/v1/companyUpdate the company profile
• PATCH/v1/company/brandingSet the brand colour
• POST/v1/company/branding/{asset}Start a logo or wordmark upload
• PUT/v1/company/branding/{asset}Publish an uploaded logo or wordmark
• DELETE/v1/company/branding/{asset}Remove the logo or wordmark
• GET/v1/company/business-hoursBusiness hours and holidays
• PUT/v1/company/business-hoursReplace business hours and holidays
• GET/v1/company/securitySecurity policy
• PUT/v1/company/securityRequire two-step verification by role
• GET/v1/settings/company-rulesBusiness rules
• PATCH/v1/settings/company-rulesSwitch business rules on or off

Consent

Consent ledger (DPDP / TRAI): grants, withdrawals, the contact consent panel and the suppression list.

• GET/v1/consentsConsent ledger of a contact
• POST/v1/consentsRecord a consent
• GET/v1/consents/contacts/{contactId}Consent panel of a contact
• POST/v1/consents/exportExport a person’s consent records (DPDP)
• GET/v1/consents/suppressionsSuppression list
• POST/v1/consents/suppressionsSuppress an address
• POST/v1/consents/suppressions/liftLift a suppression
• POST/v1/consents/withdrawRecord a withdrawal (opt-out)

Contacts

People behind leads, listings and deals — one per phone number; numbers masked with an audited reveal.

• GET/v1/contactsList contacts
• POST/v1/contactsCreate a contact
• GET/v1/contacts/{id}A contact
• PATCH/v1/contacts/{id}Update a contact
• DELETE/v1/contacts/{id}Archive a contact
• POST/v1/contacts/{id}/restoreRestore an archived contact
• POST/v1/contacts/{id}/reveal-phoneReveal a contact’s numbers

Custom fields

Extra fields of leads, contacts and listings: types, choices, required, per-role visibility.

• GET/v1/custom-fieldsCustom field definitions
• POST/v1/custom-fieldsAdd a custom field
• POST/v1/custom-fields/reorderReorder custom fields
• PATCH/v1/custom-fields/{id}Change a custom field
• DELETE/v1/custom-fields/{id}Delete a custom field

Customer portal

The buyer / owner / tenant portal (OTP sign-in for contacts): the construction updates members publish for buyers and the referrals portal users send.

• GET/v1/portal-referralsReferrals from the customer portal
• PATCH/v1/project-updates/{id}Edit or publish a construction update
• DELETE/v1/project-updates/{id}Delete a construction update
• GET/v1/projects/{id}/updatesConstruction updates of a project
• POST/v1/projects/{id}/updatesPost a construction update

Dashboard

The adaptive dashboard: your day, KPI tiles with deltas, the pipeline and the live team board.

• GET/v1/dashboard/overviewDashboard overview
• GET/v1/dashboard/pipelineDashboard pipeline
• GET/v1/dashboard/teamDashboard team board

Data & privacy

DPDP: versioned privacy notices, rights requests with the 90-day clock (access reports, corrections, erasure), retention policies and legal holds, the audit log and the full company export.

• GET/v1/privacy/audit-logsThe audit log
• GET/v1/privacy/audit-logs/exportExport the filtered audit log as CSV
• GET/v1/privacy/audit-logs/optionsValues for the audit log filters
• GET/v1/privacy/audit-logs/{id}One audit entry with its diff
• GET/v1/privacy/company-exportsFull company exports
• POST/v1/privacy/company-exportsExport all company data
• GET/v1/privacy/company-exports/{id}Download links of a finished company export
• GET/v1/privacy/holdsLegal holds
• POST/v1/privacy/holdsPlace a legal hold
• POST/v1/privacy/holds/{id}/releaseRelease a legal hold
• GET/v1/privacy/noticesPrivacy notices with their publish history
• POST/v1/privacy/noticesStart the next version of a notice (draft)
• PATCH/v1/privacy/notices/{id}Edit a draft notice
• DELETE/v1/privacy/notices/{id}Delete a draft notice
• POST/v1/privacy/notices/{id}/publishPublish a draft notice
• POST/v1/privacy/notices/{id}/retireTake a published notice down
• GET/v1/privacy/requestsDPDP rights requests
• POST/v1/privacy/requestsRecord a request received offline
• GET/v1/privacy/requests/intakeThe public request link and its QR code
• GET/v1/privacy/requests/{id}A rights request with its timeline
• PATCH/v1/privacy/requests/{id}Assign, confirm contacts, answer or close a request
• GET/v1/privacy/requests/{id}/access-reportDownload the access report
• POST/v1/privacy/requests/{id}/access-reportGenerate the access report
• POST/v1/privacy/requests/{id}/correctionApply a correction to a contact
• POST/v1/privacy/requests/{id}/eraseErase the person’s data
• POST/v1/privacy/requests/{id}/notesAdd a case note
• GET/v1/privacy/retentionRetention policies
• PUT/v1/privacy/retentionSet retention periods and switch policies on or off
• GET/v1/privacy/retention/previewDry run: what each policy would purge now
• POST/v1/privacy/retention/runRun the enabled policies now

Deals

Resale, new-booking and rental deals: stages, parties, values, documents, commission terms and splits.

• GET/v1/dealsList deals
• POST/v1/dealsOpen a deal
• GET/v1/deals/commission-summaryCommission tiles
• GET/v1/deals/membersMembers for owners and splits
• GET/v1/deals/summaryDeals per stage
• GET/v1/deals/{id}A deal
• PATCH/v1/deals/{id}Update a deal
• DELETE/v1/deals/{id}Delete a deal
• GET/v1/deals/{id}/activityThe deal’s history
• POST/v1/deals/{id}/documentsAttach an uploaded document
• POST/v1/deals/{id}/documents/presignStart a document upload
• GET/v1/deals/{id}/documents/{documentId}Download a document
• DELETE/v1/deals/{id}/documents/{documentId}Remove a document
• PUT/v1/deals/{id}/splitsSet the internal commission splits
• POST/v1/deals/{id}/stageMove a deal to another stage
• GET/v1/leads/{id}/documentsDocuments of a lead’s deals

Email sync

Members’ own Gmail and Outlook mailboxes (opt-in, read-only): emails with known contacts on the timelines, the company policy, private emails and the email viewer.

• GET/v1/email-syncMy email sync: policy, consent text and my mailboxes
• PATCH/v1/email-sync/mailboxes/{id}Pause / resume my mailbox, or change my exclusions
• DELETE/v1/email-sync/mailboxes/{id}Disconnect a mailbox
• POST/v1/email-sync/mailboxes/{id}/syncSync my mailbox now
• GET/v1/email-sync/{provider}/oauth/callbackMailbox sign-in callback
• GET/v1/email-sync/{provider}/oauth/startConnect my mailbox: the provider’s sign-in
• GET/v1/emails/{id}A synced email with its thread
• PATCH/v1/emails/{id}Mark a synced email private, or share it again
• GET/v1/settings/email-syncEmail sync policy and every connected mailbox
• PUT/v1/settings/email-syncSave the email sync policy

Exports

Lead exports with permission, row caps, watermark and an export log.

• GET/v1/exportsExport jobs
• POST/v1/exportsExport leads to CSV
• GET/v1/exports/{id}An export job
• GET/v1/exports/{id}/downloadDownload an export

Finance

• POST/v1/commission-payouts/{id}/approveApprove a payout
• POST/v1/commission-payouts/{id}/payRecord a payout’s payment
• GET/v1/commission-payouts/{id}/tds-previewWhat paying a payout would deduct
• GET/v1/deals/{id}/financeA deal’s finance timeline
• GET/v1/finance/credit-notesList credit notes
• POST/v1/finance/credit-notesIssue a credit note
• GET/v1/finance/credit-notes/{id}/documentThe credit note as PDF or print-ready HTML
• GET/v1/finance/dashboardThe finance dashboard
• GET/v1/finance/documents/by-token/{token}An invoice or credit note by its signed link
• GET/v1/finance/exports/{kind}Export finance data as CSV
• GET/v1/finance/invoicesList brokerage invoices
• POST/v1/finance/invoicesDraft an invoice
• GET/v1/finance/invoices/{id}An invoice with its receipts, credit notes and payment links
• PATCH/v1/finance/invoices/{id}Change a draft invoice
• DELETE/v1/finance/invoices/{id}Discard a draft invoice
• POST/v1/finance/invoices/{id}/cancelCancel an issued invoice
• GET/v1/finance/invoices/{id}/documentThe invoice as PDF or print-ready HTML
• POST/v1/finance/invoices/{id}/issueIssue a draft invoice
• POST/v1/finance/invoices/{id}/sendSend an invoice to the customer
• GET/v1/finance/payeesList payees
• POST/v1/finance/payeesThe payee of a member, partner or contact
• PATCH/v1/finance/payees/{id}Change a payee’s KYC, TDS facts or bank details
• PUT/v1/finance/receipts/{id}/allocationSettle an invoice with a receipt (or unlink it)
• GET/v1/finance/receivablesOpen balances per customer with ageing
• GET/v1/finance/settingsFinance settings
• PUT/v1/finance/settingsChange the finance settings
• GET/v1/finance/statements/customers/{id}A customer’s statement
• GET/v1/finance/statements/payees/{type}/{id}A payee’s statement for a financial year
• POST/v1/finance/tds/depositsRecord the challan that paid TDS
• GET/v1/finance/tds/entriesThe TDS register
• GET/v1/finance/tds/sectionsThe TDS section table
• PUT/v1/finance/tds/sections/{id}/overrideOverride a TDS section for the company
• DELETE/v1/finance/tds/sections/{id}/overrideRemove the company’s override of a TDS section
• GET/v1/finance/tds/summaryTDS of a quarter or financial year

Follow-up agent

Goal-based follow-up on a lead (book a visit, collect documents, get a decision, revive): AI drafts each touch within the company’s rules, the owner approves, edits or rejects it (autopilot only where allowed), every send goes through the messaging gates and a reply, an opt-out or the goal being met hands the lead back.

• GET/v1/followup-approvalsDrafts waiting for approval
• POST/v1/followup-approvals/{id}/approveApprove (or edit and approve) a draft
• POST/v1/followup-approvals/{id}/rejectReject a draft
• GET/v1/followup-goals/{id}A follow-up goal
• POST/v1/followup-goals/{id}/actionsPause, resume, stop or mark a goal met
• POST/v1/followup-goals/{id}/documentsMark documents received
• GET/v1/leads/{id}/followup-goalsFollow-up goals of a lead
• POST/v1/leads/{id}/followup-goalsSet a follow-up goal on a lead
• GET/v1/settings/followup-agentFollow-up agent settings
• PUT/v1/settings/followup-agentChange the follow-up agent settings

Forms

Hosted and embeddable enquiry forms: fields, versioned consent, phone OTP, spam protection, embedding.

• GET/v1/formsEnquiry forms
• POST/v1/formsCreate an enquiry form
• GET/v1/forms/{id}An enquiry form
• PATCH/v1/forms/{id}Update an enquiry form
• DELETE/v1/forms/{id}Delete an unused enquiry form

Help

Help articles for the in-app help sheet, “Was this helpful?” votes and the first-run tips you closed.

• GET/v1/help/articles/{slug}A help article
• GET/v1/help/feedback/{slug}Your vote on an article
• PUT/v1/help/feedback/{slug}Was this article helpful?
• GET/v1/help/tipsTips you closed
• DELETE/v1/help/tipsShow tips again
• PUT/v1/help/tips/{key}Close a tip

Imports

CSV / Excel imports of leads, contacts, listings, deals, notes and tasks: templates, dry run, rollback.

• GET/v1/importsImport jobs
• POST/v1/importsUpload a file to import
• GET/v1/imports/templatesSource templates
• GET/v1/imports/{id}An import job (status, progress, totals, dry-run summary)
• POST/v1/imports/{id}/mappingSave the mapping and queue the dry run
• GET/v1/imports/{id}/previewProfile, templates, mapping and value suggestions
• GET/v1/imports/{id}/reportDownload link for the dry-run report
• GET/v1/imports/{id}/rollbackWhat a rollback would undo, and what blocks it
• POST/v1/imports/{id}/rollbackRoll back an import
• GET/v1/imports/{id}/skipped-rowsDownload link for the skipped rows
• POST/v1/imports/{id}/startStart the import

Integrations

Connector catalogue, connections and their health, Meta Lead Ads and Google Ads lead forms.

• GET/v1/integrationsConnector catalogue and connections
• POST/v1/integrations/connectionsConnect an integration
• GET/v1/integrations/connections/{id}An integration connection
• PATCH/v1/integrations/connections/{id}Rename an integration connection or change its default source
• DELETE/v1/integrations/connections/{id}Disconnect an integration
• PUT/v1/integrations/connections/{id}/google/forms/{formId}Configure a Google Ads lead form
• GET/v1/integrations/connections/{id}/meta/formsLead forms of the connected Pages
• PUT/v1/integrations/connections/{id}/meta/forms/{formId}Configure a Meta lead form
• POST/v1/integrations/connections/{id}/rotateRotate a generated secret
• POST/v1/integrations/connections/{id}/testTest an integration connection
• GET/v1/integrations/healthIntegration health
• GET/v1/integrations/meta/oauth/callbackFacebook Login callback
• GET/v1/integrations/meta/oauth/startStart connecting Meta Lead Ads
• POST/v1/integrations/meta/own-appConnect Meta Lead Ads with your own Meta app
• GET/v1/integrations/parked-itemsHeld webhook items
• POST/v1/integrations/parked-items/{id}/discardDiscard a held webhook item
• POST/v1/integrations/parked-items/{id}/replayReplay a held webhook item
• POST/v1/integrations/paymentsConnect Razorpay or Cashfree
• PATCH/v1/integrations/payments/{id}Change a payment gateway’s keys or name
• POST/v1/integrations/payments/{id}/testTest a payment gateway connection
• GET/v1/integrations/portals/{portal}A portal’s onboarding guide and connections
• POST/v1/integrations/portals/{portal}Connect a portal account
• PATCH/v1/integrations/portals/{portal}/{id}Change a portal connection: source, pull settings, pull credentials, activation, project map, package end
• DELETE/v1/integrations/portals/{portal}/{id}Disconnect a portal account
• POST/v1/integrations/portals/{portal}/{id}/rotateIssue a new push URL
• POST/v1/integrations/portals/{portal}/{id}/testTest a portal pull

Integrity

Integrity alerts for managers (never shown to the agent concerned): review, dismiss, reopen.

• GET/v1/integrity/alertsIntegrity alerts
• GET/v1/integrity/alerts/{id}One integrity alert with its evidence
• POST/v1/integrity/alerts/{id}/reviewReview, dismiss or reopen an alert
• GET/v1/integrity/summaryOpen integrity alerts in numbers

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/captureRead-only group capture on my linked phone: my groups and the ones I chose
• PUT/v1/inventory-inbox/captureChoose the groups my linked phone captures (read-only; nothing is ever sent to a group)
• GET/v1/inventory-inbox/clustersThe review queue: listings and requirements seen in WhatsApp groups, latest first
• POST/v1/inventory-inbox/clusters/bulk-acceptAccept cards that are ready (every field ≥ 0.9, no flag, nothing missing, no look-alike), 25 at a time
• GET/v1/inventory-inbox/clusters/{id}One review card: the posts it was seen in, price history and fitting demand
• PATCH/v1/inventory-inbox/clusters/{id}Correct a card’s fields before deciding (kept as a draft until accepted)
• POST/v1/inventory-inbox/clusters/{id}/acceptAccept a card: a private listing or a lead; matching runs at once
• PUT/v1/inventory-inbox/clusters/{id}/duplicateSay which listing this card is (or that it is not a duplicate)
• POST/v1/inventory-inbox/clusters/{id}/mergeMerge other cards into this one (the same listing)
• POST/v1/inventory-inbox/clusters/{id}/rejectReject a card (noise teaches the parser)
• POST/v1/inventory-inbox/clusters/{id}/splitSplit posts off a card (they are another listing)
• GET/v1/inventory-inbox/ingestsImports into the inventory inbox, newest first
• POST/v1/inventory-inbox/ingestsImport a WhatsApp chat export or paste broker posts
• GET/v1/inventory-inbox/ingests/{id}An import and its progress
• POST/v1/inventory-inbox/ingests/{id}/cancelStop an import (posts not read yet are never sent to the AI)
• POST/v1/inventory-inbox/ingests/{id}/startStart reading an export uploaded with a presigned PUT
• GET/v1/inventory-inbox/settingsInventory inbox settings: forwards to the company number, how far back exports are read
• PATCH/v1/inventory-inbox/settingsChange the inventory inbox settings
• POST/v1/inventory-inbox/shareAndroid share target: a post shared from WhatsApp into the inbox
• GET/v1/inventory-inbox/summaryCounts for the queue: waiting for review, ready to bulk-accept, posts still being read

Landing pages

Project, listing and campaign pages from template blocks, with the RERA publish rules and SEO.

• GET/v1/landing-pagesLanding pages
• POST/v1/landing-pagesCreate a landing page
• POST/v1/landing-pages/micrositesCreate a listing microsite or an agent card
• GET/v1/landing-pages/{id}A landing page
• PATCH/v1/landing-pages/{id}Update a landing page’s draft
• DELETE/v1/landing-pages/{id}Delete or archive a landing page
• GET/v1/landing-pages/{id}/analyticsLanding page analytics
• POST/v1/landing-pages/{id}/experiment/winnerEnd an A/B test with a winner
• POST/v1/landing-pages/{id}/preview-linkA preview link of the draft
• POST/v1/landing-pages/{id}/publishPublish a landing page
• POST/v1/landing-pages/{id}/unpublishUnpublish a landing page
• GET/v1/landing-pages/{id}/versionsPublished versions of a landing page
• POST/v1/landing-pages/{id}/versions/{number}/restoreRestore a version (rollback)
• GET/v1/settings/site-chatSite chat settings
• PUT/v1/settings/site-chatSave the site chat settings
• GET/v1/site-domainsCustom domains
• POST/v1/site-domainsAdd a custom domain
• PATCH/v1/site-domains/{id}Change a domain’s home page
• DELETE/v1/site-domains/{id}Remove a custom domain
• POST/v1/site-domains/{id}/checkCheck a domain now
• GET/v1/site-settingsWebsite tracking and consent
• PATCH/v1/site-settingsChange website tracking and consent

Launch mode

Project launches: EOIs with unit preferences, a verifiable commit-reveal draw, automatic or live allotment (B-01 holds for the booking desk), the launch-day queue and dynamic pricing rules that draft the next price list.

• PATCH/v1/launch-eois/{id}Change an EOI’s preferences
• POST/v1/launch-eois/{id}/allotAllot the unit the holder picked (live)
• POST/v1/launch-eois/{id}/cancelCancel an EOI (an allotted unit is released)
• POST/v1/launch-eois/{id}/check-inCheck an EOI holder in at the launch
• POST/v1/launch-eois/{id}/refundRecord the refund of a cancelled EOI
• POST/v1/launch-eois/{id}/verifyVerify an EOI payment
• POST/v1/launch-price-rules/{id}/applyApply a triggered rule: draft the next price list with the scope’s BSP stepped
• POST/v1/launch-price-rules/{id}/dismissDismiss a pricing rule
• GET/v1/launchesLaunches, newest first
• POST/v1/launchesCreate a launch for a project
• GET/v1/launches/{id}A launch
• PATCH/v1/launches/{id}Change a launch
• POST/v1/launches/{id}/allotAllot units automatically in priority order
• GET/v1/launches/{id}/boardThe live launch board
• POST/v1/launches/{id}/call-nextCall the next checked-in holders in priority order
• POST/v1/launches/{id}/drawRun the draw
• GET/v1/launches/{id}/eoisEOIs of a launch, in priority order
• POST/v1/launches/{id}/eoisRecord an EOI
• GET/v1/launches/{id}/price-rulesDynamic pricing rules of a launch
• POST/v1/launches/{id}/price-rulesAdd a dynamic pricing rule
• POST/v1/launches/{id}/statusOpen or close the EOI window, go live, or close the launch

Lead Push API

Public per-source URL to push leads as JSON, form posts, XML or a GET query string.

• GET/api/ingest/{token}Push a lead as a GET query string
• POST/api/ingest/{token}Push a lead (Lead Push API)

Lead sources

Sources with cost, defaults, ingestion endpoints, health, logs with replay and the ingestion dashboard.

• GET/v1/inbound-emailsInbound lead emails
• GET/v1/inbound-emails/summaryEmails waiting for review
• GET/v1/inbound-emails/{id}An inbound lead email with its suggestion and authentication verdicts
• POST/v1/inbound-emails/{id}/approveApprove an email in review
• POST/v1/inbound-emails/{id}/dismissMark a forwarding confirmation as handled
• GET/v1/inbound-emails/{id}/rawThe raw email (.eml) — TRAI enquiry evidence
• POST/v1/inbound-emails/{id}/rejectReject an email in review
• GET/v1/sourcesLead sources
• POST/v1/sourcesCreate a lead source
• GET/v1/sources/statsIngestion dashboard
• GET/v1/sources/{id}A lead source
• PATCH/v1/sources/{id}Update a lead source
• DELETE/v1/sources/{id}Delete an unused lead source
• GET/v1/sources/{id}/emailA source’s inbound email address
• POST/v1/sources/{id}/emailTurn on a source’s inbound address
• DELETE/v1/sources/{id}/emailTurn off a source’s inbound address
• POST/v1/sources/{id}/email/rotateIssue a new inbound address
• GET/v1/sources/{id}/logsIngestion log of a source
• GET/v1/sources/{id}/logs/{eventId}One ingest event with its archived payload
• POST/v1/sources/{id}/logs/{eventId}/replayReplay an ingest event
• POST/v1/sources/{id}/rotate-tokenRotate the Lead Push URL
• GET/v1/sources/{id}/test-captureListen for a test lead

Leads

Leads with requirement, owners, the status sheet, duplicate check, merge and bulk actions.

• GET/v1/leadsList leads
• POST/v1/leadsCreate a lead
• POST/v1/leads/bulkBulk actions on leads
• GET/v1/leads/deletedRecycle bin
• GET/v1/leads/duplicatesLive duplicate check
• POST/v1/leads/mergeMerge two leads
• POST/v1/leads/restoreRestore leads from the recycle bin
• GET/v1/leads/{id}A lead
• PATCH/v1/leads/{id}Update a lead
• DELETE/v1/leads/{id}Delete a lead
• POST/v1/leads/{id}/assignAssign a lead
• GET/v1/leads/{id}/enquiriesEvery enquiry of a lead
• GET/v1/leads/{id}/flagsThe lead’s quick flags and co-agent
• POST/v1/leads/{id}/flagsTurn a quick flag on or off
• PUT/v1/leads/{id}/secondary-ownerSet or clear the lead’s co-agent
• POST/v1/leads/{id}/statusChange a lead’s status
• GET/v1/settings/duplicate-policyDuplicate policy
• PATCH/v1/settings/duplicate-policyChange the duplicate policy

Linked WhatsApp

Unofficial, opt-in: agents link their own WhatsApp by QR for 1:1 chats and replies they type — risk acceptances, company switch, devices.

• GET/v1/whatsapp/linkedLinked WhatsApp: switches, risk notices and devices
• POST/v1/whatsapp/linked/acceptAccept the linked WhatsApp risk notice
• POST/v1/whatsapp/linked/linksStart linking my WhatsApp
• DELETE/v1/whatsapp/linked/links/{id}Unlink a device
• POST/v1/whatsapp/linked/links/{id}/pair-codeLink with a code instead of the QR
• GET/v1/whatsapp/linked/links/{id}/qrQR codes of a link attempt (stream)
• POST/v1/whatsapp/linked/links/{id}/refreshRe-read a device from the bridge
• POST/v1/whatsapp/linked/links/{id}/resumeResume sending on a frozen device
• POST/v1/whatsapp/linked/opt-outWithdraw from linked WhatsApp
• PATCH/v1/whatsapp/linked/policySwitch linked WhatsApp on or off for the company

Listing freshness

Owner “still available?” pings with a tracked link, stale listings, price-revision nudges and their settings.

• GET/v1/listing-freshness/listingsStale listings
• GET/v1/listing-freshness/settingsListing freshness settings
• PATCH/v1/listing-freshness/settingsChange listing freshness settings
• POST/v1/properties/{id}/freshness/confirmMark availability confirmed with the owner
• POST/v1/properties/{id}/freshness/pingAsk the owner to confirm availability now

Listing verification

The Verified badge: an agent’s visit with geotagged photos near the listing plus an ownership-document check, reviewed by someone else; expiry, invalidation and revocation.

• DELETE/v1/listing-verification-documents/{id}Remove a pending or rejected document
• GET/v1/listing-verification-documents/{id}/downloadOpen an ownership document (60-second signed URL)
• POST/v1/listing-verification-documents/{id}/reviewApprove or reject an ownership document
• DELETE/v1/listing-verification-photos/{id}Remove a visit photo (kept as the trail)
• GET/v1/listing-verificationsVerification queue
• GET/v1/listing-verifications/{id}One verification with its photos, documents and verdict
• POST/v1/listing-verifications/{id}/cancelCancel an open verification
• POST/v1/listing-verifications/{id}/decisionGrant the Verified badge or reject the verification
• POST/v1/listing-verifications/{id}/documentsAttach an ownership document
• POST/v1/listing-verifications/{id}/documents/uploadsPresigned upload for an ownership document
• POST/v1/listing-verifications/{id}/locationUse the visit’s position as the listing’s map pin
• POST/v1/listing-verifications/{id}/photosRegister a visit photo with the phone’s location fix
• POST/v1/listing-verifications/{id}/photos/uploadsPresigned upload for a visit photo
• POST/v1/listing-verifications/{id}/returnSend a submitted visit back for retakes
• POST/v1/listing-verifications/{id}/submitSubmit the visit for review
• GET/v1/properties/{id}/verificationA listing’s badge, open verification and history
• POST/v1/properties/{id}/verificationStart (or continue) a verification visit
• POST/v1/properties/{id}/verification/revokeRevoke a listing’s Verified badge
• GET/v1/settings/listing-verificationListing verification settings
• PATCH/v1/settings/listing-verificationChange listing verification settings

Loan desk

Home-loan cases of leads and deals: eligibility (FOIR, EMI, RBI LTV slabs), the document checklist, hand-off to a lender with a document-pack link, sanction and disbursal tranches, lenders, DSAs and the commission ledger.

• GET/v1/loan-casesThe loan desk queue
• POST/v1/loan-casesOpen a loan case
• GET/v1/loan-cases/{id}A loan case
• PATCH/v1/loan-cases/{id}Edit a loan case
• PUT/v1/loan-cases/{id}/applicantsSet the applicants
• POST/v1/loan-cases/{id}/consentsAsk for (or record) the applicant’s consent to share papers with lenders
• POST/v1/loan-cases/{id}/consents/{consentId}/confirmEnter the code the applicant read back
• POST/v1/loan-cases/{id}/consents/{consentId}/withdrawRecord that the applicant withdrew consent
• POST/v1/loan-cases/{id}/disbursalsRecord a disbursal
• POST/v1/loan-cases/{id}/disbursals/{disbursalId}/reverseReverse a disbursal entered wrongly
• POST/v1/loan-cases/{id}/documentsAdd a checklist line
• PATCH/v1/loan-cases/{id}/documents/{documentId}Verify, waive or reset a checklist line
• DELETE/v1/loan-cases/{id}/documents/{documentId}Remove a checklist line
• GET/v1/loan-cases/{id}/documents/{documentId}/downloadOpen a document
• POST/v1/loan-cases/{id}/documents/{documentId}/fileAttach the uploaded file
• POST/v1/loan-cases/{id}/documents/{documentId}/uploadUpload a document
• POST/v1/loan-cases/{id}/eligibilityCheck the case’s eligibility
• POST/v1/loan-cases/{id}/handoffsHand the case off to a lender
• POST/v1/loan-cases/{id}/handoffs/{handoffId}/revokeRevoke a lender’s link
• POST/v1/loan-cases/{id}/sanctionRecord the sanction
• POST/v1/loan-cases/{id}/statusMove a loan case
• GET/v1/loan-commission-rulesLoan commission rules
• PUT/v1/loan-commission-rulesSave a commission rule
• DELETE/v1/loan-commission-rules/{id}Remove a commission rule
• GET/v1/loan-commissionsThe loan commission ledger
• POST/v1/loan-commissions/{id}/receiptsRecord commission received
• POST/v1/loan-commissions/{id}/write-offWrite off a commission
• POST/v1/loan-exportsExport loan cases (CSV)
• GET/v1/loan-exports/{id}A loan case export
• GET/v1/loan-exports/{id}/downloadDownload a loan case export
• GET/v1/loan-partnersLenders and DSAs
• POST/v1/loan-partnersAdd a lender or DSA
• PUT/v1/loan-partners/{id}Edit a lender or DSA
• POST/v1/loan-partners/{id}/statusArchive or restore a lender or DSA
• POST/v1/loans/eligibilityEligibility calculator
• GET/v1/settings/loansLoan desk settings
• PUT/v1/settings/loansSave the loan desk settings

Login devices

Device binding and login approvals: sign-in rules (approvals for new devices, device limits), members’ devices and the approvals inbox for managers and admins.

• GET/v1/login-approvalsSign-ins waiting for my approval
• GET/v1/login-approvals/{id}A sign-in request
• POST/v1/login-approvals/{id}/decisionApprove or reject a sign-in
• GET/v1/me/devicesMy devices in this workspace
• DELETE/v1/me/devices/{id}Remove one of my devices
• GET/v1/member-devicesMembers’ devices
• DELETE/v1/member-devices/{id}Remove a member’s device
• GET/v1/security/login-policySign-in rules: login approvals and device limits
• PUT/v1/security/login-policyChange the sign-in rules

Marketing studio

AI ad copy per placement and language grounded on CRM facts (RERA line and disclaimer attached), branded creatives from listing photos, social posts on a calendar, and ad audiences synced as hashed identifiers with booked-buyer suppression.

• GET/v1/marketing/ad-copyStudio sessions, newest first
• POST/v1/marketing/ad-copyWrite ad copy for a listing or project with AI
• GET/v1/marketing/ad-copy/{id}A studio session with its variants
• POST/v1/marketing/ad-copy/{id}/archiveArchive a studio session
• GET/v1/marketing/ad-copy/{id}/creativesCreatives of a studio session
• POST/v1/marketing/ad-copy/{id}/creativesRender a branded creative from a photo
• GET/v1/marketing/ad-copy/{id}/photosPhotos of the session’s listing or project that can become creatives
• PATCH/v1/marketing/ad-variants/{id}Edit an ad variant
• POST/v1/marketing/ad-variants/{id}/approveApprove an ad variant
• POST/v1/marketing/ad-variants/{id}/archiveArchive an ad variant
• GET/v1/marketing/audiencesAd audiences
• POST/v1/marketing/audiencesCreate an ad audience from a CRM segment
• POST/v1/marketing/audiences/previewWho a segment would upload
• GET/v1/marketing/audiences/{id}An ad audience with its recent sync runs
• PATCH/v1/marketing/audiences/{id}Change, pause or resume an ad audience
• POST/v1/marketing/audiences/{id}/archiveArchive an ad audience
• POST/v1/marketing/audiences/{id}/syncSync an ad audience now
• GET/v1/marketing/connectionsLive social and ad accounts
• PUT/v1/marketing/connections/metaConnect or update Meta ads audiences & posts
• DELETE/v1/marketing/connections/metaDisconnect Meta ads audiences & posts
• POST/v1/marketing/connections/meta/checkCheck the Meta tokens again
• GET/v1/marketing/social-accountsConnected social accounts
• POST/v1/marketing/social-accountsConnect a social account (demo mode until the provider apps are approved)
• POST/v1/marketing/social-accounts/{id}/disconnectDisconnect a social account
• GET/v1/marketing/social-postsPosts for the calendar
• POST/v1/marketing/social-postsDraft, schedule or publish a post
• GET/v1/marketing/social-posts/{id}A post
• PATCH/v1/marketing/social-posts/{id}Edit or reschedule a post that has not gone out
• POST/v1/marketing/social-posts/{id}/cancelCancel a draft or scheduled post
• GET/v1/settings/marketing-studioThe marketing studio settings
• PUT/v1/settings/marketing-studioSave the marketing studio settings

Matching

Explainable requirement ↔ listing matches for leads and listings.

• GET/v1/matches/leads/{leadId}Matching listings (and projects) for a lead
• GET/v1/matches/properties/{propertyId}Matching leads for a listing
• POST/v1/matches/recomputeRecompute matches now
• PATCH/v1/matches/{id}Dismiss or restore a match

Media

Photos, plans, videos and private documents of listings and projects.

• GET/v1/mediaMedia of a listing or project
• POST/v1/mediaRegister an uploaded file or an external link
• POST/v1/media/reorderReorder media
• POST/v1/media/uploadsGet an upload URL
• PATCH/v1/media/{id}Caption, room tag or cover
• DELETE/v1/media/{id}Remove a file
• GET/v1/media/{id}/downloadSigned download URL

Messaging

Compliance-gated sending (WhatsApp, DLT SMS, email), message status, inbox conversations and sending identities.

• GET/v1/conversationsConversations
• GET/v1/conversations/optionsInbox options
• POST/v1/conversations/uploadsUpload URL for an attachment
• GET/v1/conversations/{id}A conversation
• PATCH/v1/conversations/{id}Label, snooze or close a conversation
• POST/v1/conversations/{id}/assignAssign a conversation
• GET/v1/conversations/{id}/messagesMessages of a conversation
• POST/v1/conversations/{id}/readMark a conversation read
• POST/v1/conversations/{id}/typingShow “typing…” to a WhatsApp customer
• POST/v1/messagesSend a message
• GET/v1/messages/channelsSending identities
• GET/v1/messages/channels/dltDLT setup (SMS)
• PUT/v1/messages/channels/dltSave the DLT setup
• POST/v1/messages/channels/dlt/headersAdd an SMS header
• POST/v1/messages/channels/dlt/webhookNew delivery-report webhook URL
• POST/v1/messages/channels/emailAdd an email sender
• PATCH/v1/messages/channels/{id}Update an email sender
• DELETE/v1/messages/channels/{id}Disconnect a sender
• GET/v1/messages/channels/{id}/dnsDNS records of an email sender’s domain
• POST/v1/messages/channels/{id}/verifyCheck an email sender’s DNS records
• POST/v1/messages/checkCheck a message before sending
• PATCH/v1/messages/email/repliesEmail reply capture settings
• GET/v1/messages/email/reputationEmail sending health
• POST/v1/messages/email/reputation/resumeResume promotional email
• GET/v1/messages/rulesMessaging rules
• PATCH/v1/messages/rulesChange messaging rules
• PUT/v1/messages/rules/pausePause or resume customer messaging
• GET/v1/messages/{id}A message and its delivery status
• GET/v1/quick-repliesQuick replies
• POST/v1/quick-repliesAdd a quick reply
• PATCH/v1/quick-replies/{id}Edit a quick reply
• DELETE/v1/quick-replies/{id}Delete a quick reply

Mobile

The Android app: phone registration, push tokens, device tokens and the unknown-caller lookup.

• POST/v1/mobile/calls/syncUpload calls from the phone
• GET/v1/mobile/contactsThe leads this phone keeps as contacts
• POST/v1/mobile/devicesRegister this phone
• DELETE/v1/mobile/devices/{id}Remove a phone
• PUT/v1/mobile/devices/{id}/push-tokenRotate or clear the push token
• POST/v1/mobile/devices/{id}/sign-outSign this phone out
• POST/v1/mobile/diagnosticsCrash and health reports of the app
• GET/v1/mobile/lookupIs this number already in the CRM?
• GET/v1/mobile/notificationsNotifications this phone has not shown yet
• POST/v1/mobile/recordingsConfirm an uploaded call recording
• POST/v1/mobile/recordings/statusReport the phone’s recording sync
• POST/v1/mobile/recordings/uploadsAsk to upload a call recording from the phone
• GET/v1/mobile/updates/latestThe newest app build this phone may install

Notifications

Badge counters, the member’s notifications and notification preferences.

• GET/v1/announcementsLive PropZolo announcements
• GET/v1/me/countersBadge counters
• GET/v1/me/notification-preferencesMy notification preferences
• PUT/v1/me/notification-preferencesReplace my notification preferences
• GET/v1/notificationsThe member’s notifications
• POST/v1/notifications/read-allMark all notifications read
• POST/v1/notifications/{id}/readMark a notification read

Owner reports

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

• GET/v1/contacts/{id}/owner-reportAn owner’s reports
• PUT/v1/contacts/{id}/owner-report/digestStop or resume an owner’s periodic report
• PATCH/v1/owner-reports/entries/{id}Change, show or hide a line for the owner
• DELETE/v1/owner-reports/entries/{id}Remove a line for the owner
• POST/v1/owner-reports/linksGet the owner’s report link
• POST/v1/owner-reports/links/{id}/renewRenew an owner report link
• POST/v1/owner-reports/links/{id}/revokeRevoke an owner report link
• POST/v1/owner-reports/links/{id}/rotateReplace an owner report link
• POST/v1/owner-reports/links/{id}/sendSend the owner their report now
• GET/v1/owner-reports/settingsOwner report settings
• PATCH/v1/owner-reports/settingsChange owner report settings
• GET/v1/properties/{id}/owner-reportA listing’s owner report panel
• PATCH/v1/properties/{id}/owner-reportChange a listing’s owner report choices
• POST/v1/properties/{id}/owner-report/entriesAdd a line for the owner
• GET/v1/properties/{id}/owner-report/previewPreview the owner’s report

Partner portal

• GET/v1/cp/collateralPublished collateral with the partner’s co-brand line
• GET/v1/cp/inventoryProjects with released inventory and their availability
• GET/v1/cp/inventory/{id}The released units of a project, tower by tower (availability only)
• GET/v1/cp/kyc-reuseKYC verified by other builders, and what was shared here
• POST/v1/cp/kyc-reuseShare KYC verified by other builders (with consent)
• GET/v1/cp/meThe partner’s own profile, onboarding checklist, agreement and counts
• PATCH/v1/cp/meFill in or correct the partner’s own KYC details
• POST/v1/cp/me/agreement/signOpen the e-sign partner’s signing page for the partner’s agreement
• POST/v1/cp/me/documentsRegister an uploaded KYC document (a member verifies it)
• POST/v1/cp/me/documents/uploadsUpload one of the partner’s own KYC documents
• GET/v1/cp/registrationsThe partner’s registered clients with their lock status
• POST/v1/cp/registrationsRegister a client (lock window; a conflict goes to the builder as a dispute)
• POST/v1/cp/registrations/otpSend the client a one-time code that confirms their consent to the registration
• POST/v1/cp/registrations/{id}/evidenceAdd a note to the evidence of the partner’s disputed registration
• POST/v1/cp/registrations/{id}/visitsBook a site visit for a registered client (active registrations only)
• GET/v1/cp/visitsSite visits of the partner’s clients, upcoming first
• POST/v1/cp/visits/{id}/check-inGPS check-in at the site (optional photo and code); offline-safe with client_key
• POST/v1/cp/visits/{id}/otpSend the visit code to the partner’s client
• POST/v1/cp/visits/{id}/otp/verifyCheck the code the client read out at the site
• POST/v1/cp/visits/{id}/photosUpload URL for the partner’s check-in photo
• GET/v1/cp/visits/{id}/proofThe visit proof pack (PDF): OTP verification, check-in time and place, photo, timestamps

Payment links

Razorpay / Cashfree payment links for a deal’s token or brokerage, sent or copied, with automatic receipts.

• GET/v1/deals/{id}/payment-linksA deal’s payment links
• POST/v1/deals/{id}/payment-linksCreate a payment link
• POST/v1/payment-links/{id}/cancelCancel a payment link
• POST/v1/payment-links/{id}/sendSend a payment link to the payer

Pipelines

Pipelines, statuses and sub-statuses: order, colours, categories, status-sheet requirements, SLAs.

• GET/v1/pipelinesPipelines with statuses
• POST/v1/pipelinesCreate a pipeline
• POST/v1/pipelines/reorderReorder pipelines
• GET/v1/pipelines/{id}A pipeline
• PATCH/v1/pipelines/{id}Rename a pipeline, change its lead types or make it the default
• DELETE/v1/pipelines/{id}Delete a pipeline
• POST/v1/pipelines/{id}/statusesAdd a status
• POST/v1/pipelines/{id}/statuses/reorderReorder statuses
• PATCH/v1/pipelines/{id}/statuses/{statusId}Change a status
• DELETE/v1/pipelines/{id}/statuses/{statusId}Delete a status
• POST/v1/pipelines/{id}/statuses/{statusId}/sub-statusesAdd a sub-status
• POST/v1/pipelines/{id}/statuses/{statusId}/sub-statuses/reorderReorder sub-statuses
• PATCH/v1/pipelines/{id}/statuses/{statusId}/sub-statuses/{subId}Change a sub-status
• DELETE/v1/pipelines/{id}/statuses/{statusId}/sub-statuses/{subId}Delete a sub-status

Portal syndication

Listings published to property portals where a feed / API exists: per-portal rules in plain words, status, take-down, retries, the dashboard, accounts and defaults (N-06).

• GET/v1/properties/{id}/syndicationA listing on the portals
• POST/v1/properties/{id}/syndicationPublish or update the listing on portals
• POST/v1/properties/{id}/syndication/{portal}/deactivateTake the listing down from a portal
• POST/v1/properties/{id}/syndication/{portal}/retrySend a failed portal request again
• GET/v1/settings/syndicationPortal syndication settings and accounts
• PATCH/v1/settings/syndicationChange the syndication defaults
• PUT/v1/settings/syndication/accounts/{portal}Connect a portal account or change it
• DELETE/v1/settings/syndication/accounts/{portal}Disconnect a portal account
• GET/v1/syndication/dashboardPortal syndication dashboard

Post-sales

• POST/v1/post-sales/bookings/{id}/registrationRecord that a booking’s agreement was registered
• GET/v1/post-sales/filesIn-flight post-sales files (bookings, resale and rental deals)
• GET/v1/post-sales/files/{type}/{id}One post-sales file
• GET/v1/post-sales/files/{type}/{id}/checklistThe document checklist of a file
• POST/v1/post-sales/files/{type}/{id}/checklist/remindRemind the customer about missing required documents
• POST/v1/post-sales/files/{type}/{id}/checklist/{key}/reviewVerify, reject (with a reason) or reset a checklist item
• POST/v1/post-sales/files/{type}/{id}/checklist/{key}/uploadFile an uploaded document against a checklist item
• GET/v1/post-sales/files/{type}/{id}/handoverThe possession / move-in handover of a file
• PATCH/v1/post-sales/files/{type}/{id}/handoverUpdate the handover checklist (keys, meters, day, notes)
• POST/v1/post-sales/files/{type}/{id}/handover/acceptanceFile the signed possession acceptance / move-in letter
• POST/v1/post-sales/files/{type}/{id}/handover/completeComplete the handover (a blocked gate needs the override permission and a reason)
• POST/v1/post-sales/files/{type}/{id}/handover/snagsLog a snag with photos
• PATCH/v1/post-sales/files/{type}/{id}/handover/snags/{snagId}Resolve or reopen a snag
• GET/v1/post-sales/files/{type}/{id}/handover/snags/{snagId}/photos/{index}A 60-second signed URL of a snag photo
• POST/v1/post-sales/files/{type}/{id}/uploads/presignPresign a private upload for a file (checklist document, acceptance letter, snag photo)
• GET/v1/settings/post-salesPost-sales settings: checklist templates, stage SLAs, stage updates
• PUT/v1/settings/post-salesSave the post-sales settings and checklist templates

Predictive scoring

The company’s own model of the chance of a site visit or booking within 14 days: whether it ranks the leads and why, data readiness, lift, calibration and feature importance, version history, the switch and retraining.

• GET/v1/settings/predictive-scoringPredictive lead scoring: status, data readiness, the latest model and its history
• PATCH/v1/settings/predictive-scoringSwitch predictive scoring on or off, or make its thresholds stricter
• POST/v1/settings/predictive-scoring/trainRetrain the company’s model now (runs in the background; one run per 10 minutes)

Pricing & cost sheets

• PATCH/v1/charge-templates/{id}Change a charge template (published price lists keep the config frozen with them)
• GET/v1/cost-sheetsCost sheets (quotes), newest first — by project, unit, lead, status or your own
• POST/v1/cost-sheetsDraft a cost sheet for a unit (available or on hold)
• POST/v1/cost-sheets/previewCompute a unit’s cost sheet without saving it (the builder’s live preview)
• GET/v1/cost-sheets/{id}One cost sheet with its sheet, acceptance and pending approval
• PATCH/v1/cost-sheets/{id}Change a draft: discounts, lead, note or the price-list version
• POST/v1/cost-sheets/{id}/cancelCancel a draft or an issued sheet (an accepted one stays for the booking)
• POST/v1/cost-sheets/{id}/issueIssue (freeze) a draft
• GET/v1/cost-sheets/{id}/pdfThe cost sheet as PDF (a draft prints with a DRAFT watermark)
• POST/v1/cost-sheets/{id}/sendSend an issued sheet to the lead’s contact (a signed link minted at delivery)
• PATCH/v1/price-lists/{id}Edit a draft price list (published versions are frozen: 409)
• DELETE/v1/price-lists/{id}Delete a draft price list
• POST/v1/price-lists/{id}/archiveWithdraw a published version from new cost sheets (sheets quoted on it keep it)
• POST/v1/price-lists/{id}/publishPublish a draft from its effective date (today or later); its rates and template config freeze
• GET/v1/pricing/stamp-duty-statesStamp duty and registration estimates by state (unverified starting points)
• GET/v1/projects/{id}/charge-templatesCharge templates of a project
• POST/v1/projects/{id}/charge-templatesAdd a charge template (the starter set with the state’s estimate when no config is sent)
• GET/v1/projects/{id}/price-listsPrice-list versions of a project, newest first
• POST/v1/projects/{id}/price-listsDraft the next price-list version (copied from the latest unless rates are sent)
• GET/v1/settings/cost-sheetsCost-sheet settings: discount caps per role, validity, terms
• PATCH/v1/settings/cost-sheetsChange the cost-sheet settings

Process guard

Per-pipeline stage gates: allowed next stages, entry requirements, checklists with parallel sub-steps, automatic moves, the next-steps view and hand-ticked items.

• POST/v1/deals/{id}/checklistTick a checklist item of the deal’s stage
• GET/v1/deals/{id}/next-stepsValid next stages of a deal
• POST/v1/leads/{id}/checklistTick a checklist item of the lead’s stage
• GET/v1/leads/{id}/next-stepsValid next statuses of a lead
• GET/v1/settings/deal-guardThe deal stages’ process guard
• PUT/v1/settings/deal-guardChange the deal stages’ process guard
• GET/v1/settings/pipelines/{id}/guardA pipeline’s process guard
• PUT/v1/settings/pipelines/{id}/guardChange a pipeline’s process guard

Projects

New-booking project catalogue: developers, RERA numbers, configurations and price ranges.

• GET/v1/projectsList projects
• POST/v1/projectsAdd a project
• GET/v1/projects/developersDevelopers
• POST/v1/projects/developersAdd a developer
• PATCH/v1/projects/developers/{developerId}Update a developer
• GET/v1/projects/{id}A project
• PATCH/v1/projects/{id}Update a project
• DELETE/v1/projects/{id}Archive a project
• POST/v1/projects/{id}/configurationsAdd a configuration
• PATCH/v1/projects/{id}/configurations/{configurationId}Update a configuration
• DELETE/v1/projects/{id}/configurations/{configurationId}Remove a configuration
• GET/v1/projects/{id}/lead-captureWhere a project’s leads come from

Properties

Resale and rental listings: fields, statuses, price history, key register, map search and saved views.

• GET/v1/propertiesList listings
• POST/v1/propertiesCreate a listing
• GET/v1/properties/amenitiesAmenities
• POST/v1/properties/bulk/statusMove several listings to a status
• POST/v1/properties/from-leadDraft a listing from an owner lead
• GET/v1/properties/localitiesSearch localities
• GET/v1/properties/mapMap points of listings
• GET/v1/properties/viewsSaved views of the listings page
• POST/v1/properties/viewsSave a view
• PATCH/v1/properties/views/{viewId}Update a saved view
• DELETE/v1/properties/views/{viewId}Delete a saved view
• GET/v1/properties/{id}A listing
• PATCH/v1/properties/{id}Update a listing
• DELETE/v1/properties/{id}Delete a listing
• GET/v1/properties/{id}/keysKey register of a listing
• POST/v1/properties/{id}/keysRecord a key hand-over
• POST/v1/properties/{id}/statusMove a listing to another status
• GET/v1/properties/{id}/timelineTimeline of a listing
• GET/v1/settings/listingsListing settings
• PATCH/v1/settings/listingsChange listing settings

QR codes

Dynamic QR codes per placement (hoarding, newspaper, site board, brochure, event stall, CP flyer) with attribution, validity windows, scan analytics (unique devices, leads, visits, won) and print-ready images and sheets.

• GET/v1/qr-codesQR codes
• POST/v1/qr-codesCreate a QR code
• GET/v1/qr-codes/statsQR placement analytics
• GET/v1/qr-codes/{id}A QR code
• PATCH/v1/qr-codes/{id}Update a QR code
• DELETE/v1/qr-codes/{id}Delete a QR code
• GET/v1/qr-codes/{id}/dailyScans per day of a QR code
• GET/v1/qr-codes/{id}/imageThe QR code as SVG or PNG
• GET/v1/qr-codes/{id}/sheetA printable sheet of the QR code (PDF)

Re-activation

Database re-activation: dormant leads picked by preset and filter, reached only on a lawful channel (legal basis per lead), a hold-out group for the lift, the first batch’s approval, the AI agent re-qualifying replies and warm leads handed to people — funnel, lift, cost and the export.

• GET/v1/reactivation/programsRe-activation programmes
• POST/v1/reactivation/programsDraft a re-activation programme
• GET/v1/reactivation/programs/{id}A re-activation programme
• PATCH/v1/reactivation/programs/{id}Change a draft or paused programme
• DELETE/v1/reactivation/programs/{id}Delete a draft that never ran
• GET/v1/reactivation/programs/{id}/attemptsThe live log of a programme
• GET/v1/reactivation/programs/{id}/batches/{batchId}A day’s batch with sample first messages
• POST/v1/reactivation/programs/{id}/batches/{batchId}/approveApprove the programme’s first batch
• POST/v1/reactivation/programs/{id}/batches/{batchId}/rejectSend the first batch back
• POST/v1/reactivation/programs/{id}/complianceRun the AI compliance check of the programme’s messages
• POST/v1/reactivation/programs/{id}/compliance/overrideOverride an AI-only compliance finding
• GET/v1/reactivation/programs/{id}/exportExport the attempts as CSV
• POST/v1/reactivation/programs/{id}/launchLaunch (or resume) a programme
• POST/v1/reactivation/programs/{id}/message-previewThe first message for a few sample leads
• POST/v1/reactivation/programs/{id}/pausePause a running programme
• POST/v1/reactivation/programs/{id}/previewWho the programme would pick today
• GET/v1/reactivation/programs/{id}/statsFunnel, lift against the hold-out group and cost
• POST/v1/reactivation/programs/{id}/stopStop a programme for good
• GET/v1/settings/reactivationRe-activation settings
• PUT/v1/settings/reactivationChange the re-activation settings

Realtime

Server-Sent Events for notifications, inbox and live counters.

• GET/api/sseRealtime event stream

Receipts

Commission receipts with mode-specific references and per-financial-year numbers.

• GET/v1/receiptsList commission receipts
• POST/v1/receiptsRecord a commission receipt
• POST/v1/receipts/{id}/statusClear, bounce or cancel a receipt

Rent collection

An agreement’s rent: the schedule (prorated, escalated, regenerated after amendments), UPI pay links to the landlord’s own UPI id with UTR capture, AutoPay / e-NACH mandates, payments, reversals and waivers, late fees with approval, HRA-ready receipts, the Rent board and the rent settings. Rent is never brokerage revenue.

• GET/v1/rent/instalmentsThe Rent board
• POST/v1/rent/instalments/{id}/pay-linkSend the tenant the pay link
• POST/v1/rent/instalments/{id}/waiveWaive an instalment
• POST/v1/rent/late-fees/{id}/decisionApprove or waive a late fee
• POST/v1/rent/payments/{id}/decisionConfirm, reject or reverse a payment
• GET/v1/rent/payments/{id}/receiptA payment’s rent receipt (PDF)
• GET/v1/rent/receipts/by-token/{token}A rent receipt by its signed link
• GET/v1/rent/summaryThis month’s rent figures
• GET/v1/rental-agreements/{id}/rentAn agreement’s rent
• PUT/v1/rental-agreements/{id}/rentSet up rent collection
• POST/v1/rental-agreements/{id}/rent/mandateSet up AutoPay / e-NACH
• POST/v1/rental-agreements/{id}/rent/mandate/revokeRevoke the mandate
• POST/v1/rental-agreements/{id}/rent/paymentsRecord rent received
• POST/v1/rental-agreements/{id}/rent/regenerateRegenerate the rent schedule
• POST/v1/rental-agreements/{id}/rent/reveal-panThe landlord’s full PAN (audited)
• GET/v1/settings/rentRent settings
• PUT/v1/settings/rentSave the rent settings

Rental agreement settings

Agreement templates and the clause library, the stamp-duty table and company rules, e-sign status and e-stamp credits; inspection templates and the inspection & deposit settings.

• GET/v1/settings/agreement-clausesThe clause library
• POST/v1/settings/agreement-clausesAdd a clause of the company
• PATCH/v1/settings/agreement-clauses/{key}Save a clause (PropZolo’s are copied on the first save)
• GET/v1/settings/agreement-templatesAgreement templates
• POST/v1/settings/agreement-templatesCopy a template to edit it
• GET/v1/settings/agreement-templates/{key}An agreement template with its versions
• PATCH/v1/settings/agreement-templates/{key}Save a new version of a company template
• GET/v1/settings/e-signe-sign status and e-stamp credits
• GET/v1/settings/inspection-templatesInspection templates
• POST/v1/settings/inspection-templatesAdd an inspection template
• PUT/v1/settings/inspection-templates/{key}Save an inspection template
• POST/v1/settings/inspection-templates/{key}/archiveArchive / restore a template, or reset an edited PropZolo template
• GET/v1/settings/police-verification-rulesPolice verification rules
• POST/v1/settings/police-verification-rulesAdd or change a company police verification rule
• DELETE/v1/settings/police-verification-rules/{id}Remove a company police verification rule
• GET/v1/settings/rental-complianceKYC and police verification settings
• PUT/v1/settings/rental-complianceChange the KYC and police verification settings
• GET/v1/settings/rental-inspectionsInspection and deposit settings
• PUT/v1/settings/rental-inspectionsChange the inspection and deposit settings
• GET/v1/settings/stamp-dutyThe stamp-duty table
• POST/v1/settings/stamp-dutyAdd or change a company stamp-duty rule
• POST/v1/settings/stamp-duty/estimateTry the stamp-duty calculator
• DELETE/v1/settings/stamp-duty/{id}Remove a company stamp-duty rule

Rental agreements

The agreement document: templates per state and kind, clauses, stamp duty, PDF preview, e-stamp + Aadhaar e-sign through the partner, registration.

• GET/v1/rental-agreements/{id}/agreement-documentThe agreement document panel
• POST/v1/rental-agreements/{id}/agreement-documentDraft the agreement from a template
• PATCH/v1/rental-agreements/{id}/agreement-documentSave the draft
• POST/v1/rental-agreements/{id}/agreement-document/cancelCancel the signing request
• GET/v1/rental-agreements/{id}/agreement-document/previewThe draft as a PDF
• POST/v1/rental-agreements/{id}/agreement-document/registrationStart the registration checklist
• PUT/v1/rental-agreements/{id}/agreement-document/registrationRecord the registration number
• POST/v1/rental-agreements/{id}/agreement-document/sendSend for e-stamp and Aadhaar e-sign
• GET/v1/rental-agreements/{id}/agreement-document/signedDownload the signed agreement or its audit trail
• POST/v1/rental-agreements/{id}/agreement-document/signers/{signerId}/resendSend a signer’s link again
• GET/v1/rental-agreements/{id}/complianceThe documents & compliance panel
• POST/v1/rental-agreements/{id}/kycAsk a party for KYC
• POST/v1/rental-agreements/{id}/kyc/{requestId}/cancelCancel a KYC request
• POST/v1/rental-agreements/{id}/kyc/{requestId}/decisionAccept or reject a KYC result in review
• GET/v1/rental-agreements/{id}/kyc/{requestId}/photoThe person’s KYC photo
• POST/v1/rental-agreements/{id}/kyc/{requestId}/resendSend a KYC link again
• PUT/v1/rental-agreements/{id}/police-verificationRecord the police verification
• GET/v1/rental-agreements/{id}/police-verification/acknowledgementDownload the police acknowledgement
• POST/v1/rental-agreements/{id}/police-verification/acknowledgement/presignStart the acknowledgement upload
• GET/v1/rental-agreements/{id}/police-verification/formThe prefilled police verification form (PDF)

Rental deposits

The deposit ledger: who holds it (landlord, escrow partner, the brokerage in trust), money received, paid to the landlord and refunded (append-only), deductions from the comparison with the tenant’s answers, the settlement and the statement — never brokerage revenue.

• POST/v1/rental-agreements/{id}/deductionsAdd a deduction by hand
• POST/v1/rental-agreements/{id}/deductions/proposeAdd the comparison’s proposals as draft deductions
• POST/v1/rental-agreements/{id}/deductions/sendSend the deductions to the tenant
• POST/v1/rental-agreements/{id}/deductions/unpaid-rentRecover unpaid rent from the deposit
• GET/v1/rental-agreements/{id}/depositThe deposit of a rental agreement
• PUT/v1/rental-agreements/{id}/depositThe agreed deposit and who holds it
• POST/v1/rental-agreements/{id}/deposit/entriesRecord deposit money
• POST/v1/rental-agreements/{id}/deposit/escrowEscrow account: open, release or check
• GET/v1/rental-agreements/{id}/deposit/statementThe deposit statement (PDF)
• PATCH/v1/rental-deductions/{id}Change a deduction
• POST/v1/rental-deductions/{id}/resolveResolve a disputed deduction
• POST/v1/rental-deductions/{id}/responseRecord the tenant’s answer
• POST/v1/rental-deductions/{id}/waiveWaive a deduction
• POST/v1/rental-deposit-entries/{id}/reverseReverse a deposit entry

Rental inspections

Move-in / move-out inspections: room-by-room checklists, ratings, EXIF/GPS-free photo and video previews, meter readings, inventory and keys, captured offline-tolerant on the phone; signatures of both parties (typed name, drawing, one-time code) that lock the inspection; corrections; move-out compared side by side with move-in.

• GET/v1/rental-agreements/{id}/comparisonMove-out compared with move-in
• GET/v1/rental-agreements/{id}/comparison/reportDownload the comparison report
• POST/v1/rental-agreements/{id}/comparison/reportRender the comparison report again
• GET/v1/rental-agreements/{id}/inspectionsThe inspections of a rental agreement
• POST/v1/rental-agreements/{id}/inspectionsStart an inspection
• PUT/v1/rental-agreements/{id}/tenancyRecord the move-in, the notice and the move-out
• DELETE/v1/rental-inspection-media/{id}Remove a photo / video
• GET/v1/rental-inspections/{id}An inspection
• PATCH/v1/rental-inspections/{id}/answersSave answers (offline queue)
• POST/v1/rental-inspections/{id}/cancelCancel a draft
• POST/v1/rental-inspections/{id}/completeReady for signatures
• POST/v1/rental-inspections/{id}/mediaAdd an uploaded photo / video
• POST/v1/rental-inspections/{id}/media/uploadsStart a photo / video upload
• POST/v1/rental-inspections/{id}/reopenReopen for changes
• GET/v1/rental-inspections/{id}/reportDownload the signed inspection report
• POST/v1/rental-inspections/{id}/reviseCorrect a signed inspection
• POST/v1/rental-inspections/{id}/signatures/{party}/otpSend a party their signing code (at the handover)
• POST/v1/rental-inspections/{id}/signatures/{party}/revokeStop a party’s signing link
• POST/v1/rental-inspections/{id}/signatures/{party}/sendSend a party their signing link
• POST/v1/rental-inspections/{id}/signatures/{party}/signSign for a party on this phone (at the handover)

Rental maintenance

Maintenance tickets of managed rentals: WhatsApp intake with photos, AI triage the agent confirms, vendors with dispatch and update links, the owner’s approval above a threshold, SLA timers, the tenant’s confirmation.

• GET/v1/maintenance-media/{id}/downloadOpen a ticket’s file
• GET/v1/maintenance-ticketsThe maintenance queue
• POST/v1/maintenance-ticketsRecord a repair request
• GET/v1/maintenance-tickets/{id}A ticket with its timeline and photos
• POST/v1/maintenance-tickets/{id}/approvalRecord the owner’s decision
• POST/v1/maintenance-tickets/{id}/assignAssign a vendor
• POST/v1/maintenance-tickets/{id}/estimateRecord the estimate and who pays
• POST/v1/maintenance-tickets/{id}/mediaRegister an uploaded file
• POST/v1/maintenance-tickets/{id}/media/uploadsUpload a photo, video or invoice
• POST/v1/maintenance-tickets/{id}/notesAdd a note to the timeline
• POST/v1/maintenance-tickets/{id}/statusMove a ticket
• POST/v1/maintenance-tickets/{id}/triageConfirm or correct the triage
• GET/v1/maintenance-vendorsThe vendor directory
• POST/v1/maintenance-vendorsAdd a vendor
• PUT/v1/maintenance-vendors/{id}Edit a vendor
• POST/v1/maintenance-vendors/{id}/statusArchive or restore a vendor
• GET/v1/rental-agreements/{id}/maintenanceAn agreement’s maintenance
• PUT/v1/rental-agreements/{id}/maintenanceSet the owner-approval threshold
• POST/v1/rental-agreements/{id}/maintenance/tenant-linkSend the tenant their repair request link
• GET/v1/settings/rental-maintenanceMaintenance settings
• PUT/v1/settings/rental-maintenanceSave the maintenance settings

Rental offers

Versioned offer terms on rental deals, asked vs offered vs the owner’s floor, and the owner-floor approval (the owner’s decision link and/or the approval chain).

• GET/v1/deals/{id}/offersThe offer panel of a rental deal
• POST/v1/deals/{id}/offersMake an offer or a counter-offer
• POST/v1/deals/{id}/offers/{offerId}/acceptAccept the live offer
• POST/v1/deals/{id}/offers/{offerId}/rejectThe other side declined the offer
• POST/v1/deals/{id}/offers/{offerId}/send-to-ownerSend the offer to the owner for a decision
• POST/v1/deals/{id}/offers/{offerId}/withdrawThe offer’s own side withdrew it
• GET/v1/settings/rental-pipelineRental pipeline defaults
• PUT/v1/settings/rental-pipelineChange the rental pipeline defaults

Rentals

Rental agreements, renewal reminders (T-60 / 45 / 30) and renewal deals.

• GET/v1/rental-agreementsList rental agreements
• POST/v1/rental-agreementsRecord a rental agreement
• GET/v1/rental-agreements/{id}A rental agreement
• PATCH/v1/rental-agreements/{id}Update a rental agreement
• DELETE/v1/rental-agreements/{id}Delete a rental agreement
• GET/v1/rental-agreements/{id}/documentDownload the agreement document
• PUT/v1/rental-agreements/{id}/documentAttach the signed agreement
• POST/v1/rental-agreements/{id}/document/presignStart the agreement document upload
• POST/v1/rental-agreements/{id}/renewalDraft the renewal deal

Report builder

Reports you build: an entity, filters, a group-by and a split, measures (counts, totals, averages, conversion rates, cost per lead), charts, drill-down to records, private / team / company sharing and versions — always within the reader’s own report scope.

• GET/v1/reports/builder/catalogueWhat I can report on
• POST/v1/reports/builder/drillRecords behind a report cell
• POST/v1/reports/builder/runRun a report
• GET/v1/reports/customSaved reports
• POST/v1/reports/customSave a report
• GET/v1/reports/custom/{id}A saved report
• PATCH/v1/reports/custom/{id}Change a saved report
• DELETE/v1/reports/custom/{id}Delete a saved report
• POST/v1/reports/custom/{id}/duplicateCopy a report
• GET/v1/reports/custom/{id}/exportDownload a report as CSV
• POST/v1/reports/custom/{id}/runRun a saved report
• GET/v1/reports/custom/{id}/versionsVersions of a saved report
• POST/v1/reports/custom/{id}/versions/{version}/restoreRestore a version

Reports

Owner dashboard, status matrices, speed to lead & SLA, agent scorecard, visits / shares / messaging reports, campaign costs and the daily owner digest — within your report scope.

• GET/v1/reports/agent-activityAgent activity matrix
• GET/v1/reports/agent-activity/exportDownload the agent activity matrix as CSV
• GET/v1/reports/campaignsCampaign & source costs
• GET/v1/reports/ctwaClick-to-WhatsApp attribution
• GET/v1/reports/dashboardOwner dashboard
• GET/v1/reports/digestDaily owner digest
• PATCH/v1/reports/digestChange the daily owner digest
• GET/v1/reports/engagementShares & matching report
• GET/v1/reports/matrixStatus matrix
• GET/v1/reports/messagingMessaging report
• GET/v1/reports/scorecardAgent scorecard
• GET/v1/reports/speed-to-leadSpeed to lead & SLA
• GET/v1/reports/visit-funnelVisit & meeting funnel
• GET/v1/reports/visit-funnel/exportDownload the visit & meeting funnel as CSV
• GET/v1/reports/visitsVisits report

SLA policies

First response, first call, first site visit, time in stage and overdue tasks on business-hours clocks, with the escalation ladder and the SLA dashboard.

• GET/v1/reports/slaSLA dashboard
• GET/v1/settings/sla-policiesSLA policies
• POST/v1/settings/sla-policiesAdd an SLA policy
• PATCH/v1/settings/sla-policies/{id}Change an SLA policy
• DELETE/v1/settings/sla-policies/{id}Delete an SLA policy

Saved views

Private and team views of the CRM lists, and counts for their tabs.

• GET/v1/saved-viewsSaved views of a list
• POST/v1/saved-viewsSave a view
• POST/v1/saved-views/countsCounts for list tabs
• PATCH/v1/saved-views/{id}Change, rename or re-share a view
• DELETE/v1/saved-views/{id}Delete a view

Scheduled reports

Daily, weekly or monthly delivery of a report by email (table + CSV) and WhatsApp (summary), the delivery log, outside recipients with step-up and one-click unsubscribe, and the daily owner digest as a schedulable preset.

• GET/v1/reports/custom/{id}/schedulesSchedules of a report
• POST/v1/reports/custom/{id}/schedulesSchedule a report
• GET/v1/reports/delivery-settingsScheduled report delivery settings
• PATCH/v1/reports/delivery-settingsAllow or stop reports to outside addresses
• PATCH/v1/reports/schedules/{id}Change, pause or resume a schedule
• DELETE/v1/reports/schedules/{id}Delete a schedule
• GET/v1/reports/schedules/{id}/deliveriesDelivery log of a schedule
• PUT/v1/reports/schedules/{id}/external-recipientsOutside email recipients of a schedule
• POST/v1/reports/schedules/{id}/sendSend a scheduled report now

Search

Global search behind the command palette.

• GET/v1/searchSearch leads and contacts

Session

The signed-in member and the workspace configuration clients load at start.

• GET/v1/bootstrapWorkspace configuration
• GET/v1/meThe signed-in member

Shares

Tracked share links with views, reactions and hot signals.

• GET/v1/sharesShare links
• POST/v1/sharesCreate a tracked share link
• GET/v1/shares/recipientsLeads to share with
• GET/v1/shares/{id}A share link with its views
• POST/v1/shares/{id}/revokeRevoke a share link

Site visits

Tours with conflict warnings, the calendar, reminders, the client OTP, GPS check-in / out, feedback, no-shows.

• GET/v1/visitsList site visits
• POST/v1/visitsSchedule a site visit
• GET/v1/visits/analyticsVisit analytics
• GET/v1/visits/calendarVisits calendar with agent lanes
• GET/v1/visits/conflictsThe agent’s nearby visits
• GET/v1/visits/settingsSite visit settings
• PATCH/v1/visits/settingsChange site visit settings
• GET/v1/visits/{id}A site visit
• PATCH/v1/visits/{id}Change a visit
• POST/v1/visits/{id}/cancelCancel a visit
• GET/v1/visits/{id}/certificateThe visit certificate
• POST/v1/visits/{id}/check-inCheck in at the site
• POST/v1/visits/{id}/check-outCheck out and finish the visit
• POST/v1/visits/{id}/completeMark the visit as done
• POST/v1/visits/{id}/confirmMark the visit confirmed
• POST/v1/visits/{id}/feedbackRecord visit feedback
• POST/v1/visits/{id}/no-showMark a no-show
• POST/v1/visits/{id}/otpSend the visit code to the client
• POST/v1/visits/{id}/otp/verifyCheck the client’s visit code
• POST/v1/visits/{id}/photosUpload URL for a check-in photo
• POST/v1/visits/{id}/rescheduleReschedule a visit

Status

Live platform health with incidents and planned maintenance — the data behind /status.

• GET/v1/statusPropZolo status

Support

Tickets to PropZolo support: open one, follow the thread, reply with screenshots, mark it solved.

• GET/v1/support/ticketsYour support tickets
• POST/v1/support/ticketsAsk PropZolo support
• GET/v1/support/tickets/{id}A ticket and its thread
• POST/v1/support/tickets/{id}/messagesReply in a ticket
• POST/v1/support/tickets/{id}/resolveMark a ticket as solved
• POST/v1/support/uploadsUpload URL for a ticket attachment

System

Health checks and this document.

• GET/api/healthLiveness and readiness
• GET/v1/openapi.jsonOpenAPI 3.1 document

Tasks

Tasks and follow-ups: due times, reminders, recurrence, snooze, overdue / today / upcoming and the calendar.

• GET/v1/tasksList tasks
• POST/v1/tasksCreate a task
• GET/v1/tasks/summaryOverdue / today / upcoming counts
• GET/v1/tasks/{id}A task
• PATCH/v1/tasks/{id}Update a task
• DELETE/v1/tasks/{id}Cancel a task
• POST/v1/tasks/{id}/completeComplete a task
• POST/v1/tasks/{id}/reopenReopen a task
• POST/v1/tasks/{id}/snoozeSnooze a task

Team

Members, invitations, roles and the permission matrix, teams, branches and API keys (Settings → Team).

• GET/v1/api-keysAPI keys
• POST/v1/api-keysCreate an API key
• DELETE/v1/api-keys/{id}Revoke an API key
• GET/v1/branchesBranches
• POST/v1/branchesAdd a branch
• PATCH/v1/branches/{id}Edit a branch
• DELETE/v1/branches/{id}Remove a branch
• GET/v1/invitationsPending invitations
• POST/v1/invitationsInvite someone
• DELETE/v1/invitations/{id}Withdraw an invitation
• POST/v1/invitations/{id}/resendSend an invitation again
• GET/v1/membersTeam members
• GET/v1/members/localitiesLocalities for service areas
• GET/v1/members/optionsMembers for pickers
• GET/v1/members/{id}A team member
• PATCH/v1/members/{id}Edit a team member
• POST/v1/members/{id}/deactivateDeactivate a team member
• POST/v1/members/{id}/reactivateReactivate a team member
• GET/v1/rolesRoles
• POST/v1/rolesCreate or duplicate a role
• GET/v1/roles/{id}A role with its permissions
• PATCH/v1/roles/{id}Edit a role
• DELETE/v1/roles/{id}Delete an unused custom role
• POST/v1/roles/{id}/diffPreview a permission change
• GET/v1/teamsTeams
• POST/v1/teamsCreate a team
• PATCH/v1/teams/{id}Edit a team
• DELETE/v1/teams/{id}Delete a team

Telephony

Cloud telephony (Exotel): the connection, virtual numbers per lead source with validity dates, A2P declarations, recording and missed-call settings.

• POST/v1/integrations/telephonyConnect Exotel
• PATCH/v1/integrations/telephony/{id}Change the telephony keys, SID, cluster or name
• POST/v1/integrations/telephony/{id}/sync-numbersFetch the ExoPhones
• POST/v1/integrations/telephony/{id}/testTest the telephony connection
• GET/v1/telephonyTelephony overview
• PATCH/v1/telephony/declarations/{id}Move an A2P declaration forward
• GET/v1/telephony/declarations/{id}/documentOpen the filed declaration
• POST/v1/telephony/declarations/{id}/uploadUpload the filed declaration
• PATCH/v1/telephony/number-sources/{id}Change or end a number’s source period
• DELETE/v1/telephony/number-sources/{id}Remove a number’s source period
• POST/v1/telephony/numbersAdd a virtual number by hand
• PATCH/v1/telephony/numbers/{id}Change a virtual number
• POST/v1/telephony/numbers/{id}/declarationsRecord an A2P declaration of a number
• POST/v1/telephony/numbers/{id}/sourcesLet a number stand for a lead source
• PUT/v1/telephony/settingsChange the telephony settings

Templates

SMS (DLT), email and WhatsApp templates with variables, previews, the seeded library and DLT import.

• GET/v1/templatesMessage templates
• POST/v1/templatesCreate a template
• POST/v1/templates/dlt-importImport DLT templates (CSV)
• POST/v1/templates/libraryAdd the template library
• POST/v1/templates/previewPreview an unsaved template
• GET/v1/templates/variablesVariables a template can use
• GET/v1/templates/{id}A template
• PATCH/v1/templates/{id}Update a template
• DELETE/v1/templates/{id}Delete a template
• POST/v1/templates/{id}/previewPreview a template

Timeline

The timeline of a lead or a contact: notes with @mentions, status changes, calls, visits and system events.

• GET/v1/activitiesTimeline of a lead or a contact
• POST/v1/activitiesAdd a note
• PATCH/v1/activities/{id}Edit a note / pin an entry

Unit inventory

• GET/v1/projects/{id}/availabilityInventory availability by tower and configuration
• GET/v1/projects/{id}/inventory-itemsParking and storerooms of a project
• POST/v1/projects/{id}/inventory-itemsAdd a range of parking slots or storerooms (existing codes are skipped)
• PATCH/v1/projects/{id}/inventory-items/{itemId}Edit a parking slot or storeroom
• DELETE/v1/projects/{id}/inventory-items/{itemId}Remove a parking slot or storeroom (refused while held, booked or sold)
• POST/v1/projects/{id}/inventory-items/{itemId}/allocationAllocate to a unit (or take off one with unit_id null)
• POST/v1/projects/{id}/inventory-items/{itemId}/holdHold a parking slot or storeroom sold on its own
• GET/v1/projects/{id}/releasesRelease phases of a project
• POST/v1/projects/{id}/releasesPlan a release phase
• POST/v1/projects/{id}/releases/{releaseId}/releasePut a planned phase on sale
• POST/v1/projects/{id}/releases/{releaseId}/unitsPut units into a phase (live units are refused)
• POST/v1/projects/{id}/releases/{releaseId}/withdrawTake a phase off sale (only units nobody is working on)
• GET/v1/projects/{id}/towersTowers of a project with unit counts per status
• POST/v1/projects/{id}/towersAdd a tower (optionally laying out its units)
• PATCH/v1/projects/{id}/towers/{towerId}Edit a tower
• DELETE/v1/projects/{id}/towers/{towerId}Remove a tower and its units (refused while any is held, booked or sold)
• GET/v1/projects/{id}/towers/{towerId}/gridThe tower grid: floors × stacks with every unit
• POST/v1/projects/{id}/towers/{towerId}/unitsAdd one unit to a tower
• POST/v1/projects/{id}/towers/{towerId}/units/generateLay out units by a numbering scheme (existing numbers are kept)
• GET/v1/projects/{id}/unitsUnits of a project (the grid’s list view), filtered
• POST/v1/projects/{id}/units/bulk-statusBlock, unblock or hold back many units (live units are skipped)
• POST/v1/projects/{id}/units/importImport units from the builder’s sheet (dry run, then apply)
• GET/v1/projects/{id}/units/{unitId}One unit with its hold history and parking
• PATCH/v1/projects/{id}/units/{unitId}Edit a unit (prices need units.price_edit)
• DELETE/v1/projects/{id}/units/{unitId}Remove a unit (refused while held, booked, sold or linked to a deal)
• POST/v1/projects/{id}/units/{unitId}/holdHold an available unit (atomic; 409 when someone else got it first)
• POST/v1/projects/{id}/units/{unitId}/statusChange a unit’s status by hand (blocking needs a reason; booking converts a hold)
• GET/v1/settings/unit-holdsUnit hold settings
• PATCH/v1/settings/unit-holdsChange unit hold settings
• GET/v1/unit-holdsRunning holds: mine, or every hold within my release scope (pending extensions first)
• POST/v1/unit-holds/{id}/extensionAsk for the one extension a hold may get (the holder)
• POST/v1/unit-holds/{id}/extension/decisionApprove or deny an extension — or grant one unasked (a manager, never the holder)
• POST/v1/unit-holds/{id}/releaseRelease a hold (the holder, or a manager within units.release scope)

Voice debriefs

Short spoken notes about a lead: upload, transcription (speech to text, metered), the AI’s proposed update with the words each part came from, review and apply (requirement, status, follow-up, tasks) — and the voice settings.

• GET/v1/voice-debriefsMy voice debriefs
• POST/v1/voice-debriefsRegister a recorded voice debrief
• POST/v1/voice-debriefs/uploadsUpload URL for a voice debrief
• GET/v1/voice-debriefs/{id}A voice debrief
• POST/v1/voice-debriefs/{id}/applyApply a reviewed voice debrief
• GET/v1/voice-debriefs/{id}/audioListen to a voice debrief (short-lived link)
• POST/v1/voice-debriefs/{id}/discardDiscard a voice debrief
• POST/v1/voice-debriefs/{id}/transcriptType or correct a debrief’s transcript
• GET/v1/voice/settingsVoice settings
• PATCH/v1/voice/settingsChange the voice settings

Walk-ins

Site-office kiosks (pairing, revoking, questions, branding), the walk-in policy (CP lock window, versioned consent notice) and the site-office queue with tokens, waiting times and site visits.

• GET/v1/kiosksSite-office kiosks
• POST/v1/kiosksEnrol a kiosk
• GET/v1/kiosks/policyThe walk-in policy
• PUT/v1/kiosks/policyUpdate the walk-in policy
• GET/v1/kiosks/{id}A kiosk
• PATCH/v1/kiosks/{id}Update a kiosk
• POST/v1/kiosks/{id}/pairingA new pairing code for a kiosk
• POST/v1/kiosks/{id}/revokeRevoke a kiosk
• GET/v1/walk-insThe site-office queue
• GET/v1/walk-ins/{id}A walk-in
• POST/v1/walk-ins/{id}/statusMove a walk-in through the queue
• POST/v1/walk-ins/{id}/visitStart the site visit of a walk-in

Webhooks

Signed outgoing webhooks: endpoints, events, secret rotation, test events, the delivery log and replays.

• GET/v1/webhook-deliveriesWebhook delivery log
• POST/v1/webhook-deliveries/{id}/replayReplay one delivery
• GET/v1/webhooksWebhook endpoints and automation subscriptions
• POST/v1/webhooksAdd a webhook endpoint
• GET/v1/webhooks/eventsEvents an endpoint can receive
• POST/v1/webhooks/workflow-secretShow or rotate the workflow signing secret
• GET/v1/webhooks/{id}A webhook endpoint
• PATCH/v1/webhooks/{id}Change, pause or resume a webhook endpoint
• DELETE/v1/webhooks/{id}Remove a webhook endpoint or subscription
• POST/v1/webhooks/{id}/rotate-secretRotate an endpoint’s signing secret
• POST/v1/webhooks/{id}/testSend a test event

WhatsApp

WhatsApp Cloud API: connect with your own credentials or Embedded Signup, numbers with quality and tier, templates with Meta.

• POST/v1/whatsapp/assistedOpen a WhatsApp draft on the phone (wa.me)
• POST/v1/whatsapp/connectConnect WhatsApp with your own credentials
• DELETE/v1/whatsapp/connections/{id}Disconnect WhatsApp
• POST/v1/whatsapp/connections/{id}/refreshRefresh numbers from Meta
• POST/v1/whatsapp/connections/{id}/registerRegister a WhatsApp number
• POST/v1/whatsapp/embedded-signupFinish WhatsApp Embedded Signup
• PATCH/v1/whatsapp/settingsWhatsApp messaging settings
• GET/v1/whatsapp/setupWhatsApp connections and numbers
• POST/v1/whatsapp/templates/syncSync templates from Meta
• POST/v1/whatsapp/templates/uploadsUpload a template header file
• POST/v1/whatsapp/templates/{id}/submitSubmit a template to Meta
• POST/v1/whatsapp/testTest WhatsApp credentials

White label

Enterprise white label (N-09): brand name, accent colour, "powered by", email sender, workspace domains verified by DNS and the branded Android app’s build manifest.

• GET/v1/white-labelWhite label
• PATCH/v1/white-labelChange the white label
• GET/v1/white-label/android-manifestBranded Android app manifest
• GET/v1/white-label/domainsWorkspace domains
• POST/v1/white-label/domainsAdd a workspace domain
• DELETE/v1/white-label/domains/{id}Remove a workspace domain
• POST/v1/white-label/domains/{id}/checkCheck a workspace domain now