For support support@leadrat.com
- Leadrat
- Zones
- Zone Plans
- Villas
- Project Access
- User Management
- Units
- Get unit by ID
- Update an existing unit
- Update unit amenities
- Get units with pagination
- Create a new unit
- Search units with filters
- Batch save units
- Batch save units with hierarchy
- Get unit booking details
- Get all units as list
- Get all units for a project
- Delete all units in a project
- Get units by floor
- Get booked units
- Delete all units by tower
- Towers
- Tenant Configuration
- TDS Configuration Module
- Taxes
- Subscription Management
- Subscription Plans
- Roles & Permissions
- Reminder Schedules
- Receipts
- Project Stakeholders
- Projects
- Get project by ID
- Update an existing project
- Update project amenities
- Get projects with pagination
- Create a new project
- Upload projects from Excel file (Direct)
- Upload projects from Excel file
- Confirm and save projects from JSON data
- Search projects with filters
- Get project audit trail
- Download project upload template
- Get project summary
- Get project statistics
- Get projects with towers for milestones
- Get all projects as list
- Get booked projects
- Project Wizard
- Payment Plans
- Get payment plan by ID
- Update payment plan
- Batch create payment plans for a tower
- Batch create payment plans for a project
- Get payment plans with pagination
- Create a payment plan
- Search payment plans
- Get payment plans by tower
- Get payment plans by project
- Get payment plan statistics
- Get all payment plans as list
- Get payment plans by project or tower
- Payment Plan Lines
- Notification Logs
- Get notification log by ID
- Update notification log
- Get notification logs with pagination
- Create notification log
- Search notification logs
- Get notification summary
- Get all notification logs as list
- Get notifications by status
- Get notifications for a specific reference
- Get notifications by reference type
- Get notifications for a specific recipient
- Get notifications by recipient type
- Get notifications within a date range
- Get notifications by channel
- Milestones
- Get milestone by ID
- Update a milestone
- Delete milestone
- Mark milestone as complete
- Reorder milestones
- Batch save milestones
- Get milestones with pagination
- Create a milestone
- Search milestones
- Get milestones by tower
- Get milestones by project
- Preview milestone completion
- Get milestones as template
- Get milestone statistics
- Get all milestones as list
- Handover Checklist Template
- Get template by ID
- Update template and its items
- Delete template and its items
- Unarchive a template
- Archive a template
- List templates with card stats (category + search filter)
- Create a new checklist template
- Clone an existing checklist template
- Assign template to a unit's active handover case
- Assign template to a handover case
- Handover Documents
- Handover Case
- Get handover case by ID
- Update core handover case details
- Soft delete a handover case
- Change checklist template
- Advance case to next stage
- Update sale deed and registration details
- Update NRI compliance tracking fields
- List all handover cases (paginated)
- Create a new handover case
- Send possession reminder to buyer
- Schedule handover and offer possession
- Schedule NRI video possession
- Upload or update NRI compliance document item
- Search handover cases
- Batch possession offer-letter hook
- Calculate estimated stamp duty
- Get Sale Deed & Registration timeline
- Get dashboard summary for a case
- Get case by booking ID
- Handover Snags
- Get a single snag by ID
- Update a snag's editable fields
- Waive a snag
- Mark snag as resolved
- Mark snag as in progress
- Record buyer sign-off for a specific snag resolution
- Assign snag to a staff member
- Get all snags for a case
- Log a new snag item
- Get snag statistics breakdown
- Search snags in a case
- Get only open (unresolved) snags
- Filter snags by status
- Handover Checklist
- Update checklist item
- Mark item as incomplete
- Mark item (keys/cards) as physically handed over
- Attach a handover document to checklist item
- Detach a handover document from checklist item
- Get documents attached to a checklist item
- Create and attach a document to a checklist item
- Sign possession receipt
- Add custom checklist item
- Get key-handover checklist
- Generated Documents
- Dynamic Forms
- Floors
- Floor Rise Charge
- Floor Plans
- Financing Details
- Document Templates
- Demands
- Demand Splits
- Commissions
- Get commission by ID
- Update a commission
- Update commission status
- List commissions (paginated)
- Create a new commission
- Send commission notification
- search_1
- Get commission ledger
- Download commission PDF
- List commissions by status
- Get commission KPIs
- List commissions by partner type
- List commissions for a booking
- Commission Settings
- Commission Payouts
- Mark a commission payout as paid (after bank transfer/cheque)
- Cancel a commission payout
- Approve a commission payout (finance team action)
- Send commission payout notification
- Record a partial commission payment
- List all commission payouts
- Get a commission payout by ID
- Get commission payout ledger
- Download commission payout PDF
- Get commission payout KPIs
- List all payouts pending finance approval
- List all paid payouts
- List all payouts for a specific commission
- List all payouts for a specific booking
- List all approved payouts
- Charge Templates
- Channel Partners
- Buyers
- Builders
- Brokers
- Bookings
- Banks
- Amenities
- Vault
- Authentication
- Reports - Revenue
- Reports - Inventory
- Reports - Dashboard
- Reports - Buyer
- Reports - Booking
- Project Assets
- notification-controller
- Configuration
- Document Generation
- Audit Trail
- Accounting
- scalar-documentation-controller
- Project Statistics
- Booking Statistics
- Platform Dashboard
- Handover List
- Handover Snag Board
- Handover Analytics
- NRI Compliance
- Document Configuration
- Audit
- Schemas
- ZoneDto
- ZonePlanDto
- VillaDto
- ProjectAccessRequest
- ProjectAccessDto
- ErrorResponseDto
- UserRequest
- UserDto
- AssignRoleRequest
- AmenityCollectionDto
- AmenityDto
- UnitDto
- TowerDto
- TenantConfiguration
- TdsDto
- TaxDto
- SubscriptionUpdateRequest
- Subscription
- SubscriptionPlanDto
- RoleRequest
- RoleResponse
- ReminderScheduleDto
- DemandBreakdownItem
- DemandDto
- DemandSplitDto
- ReceiptDto
- ProjectStakeholderDto
- Address
- Coordinate
- ProjectDto
- EmbeddedMilestoneDto
- PaymentPlanDto
- PaymentPlanLineDto
- NotificationLogDto
- MilestoneDto
- HandoverChecklistTemplateDto
- HandoverChecklistTemplateItemDto
- HandoverDocumentDto
- HandoverCaseDto
- SnagItemDto
- UpdateRegistrationRequest
- UpdateNriComplianceRequest
- HandoverChecklistUpdateDto
- HandoverChecklistItemDto
- GeneratedDocumentDto
- FormDto
- JsonNode
- FloorDto
- FloorRiseSlabDto
- FloorRiseConfigDto
- FloorPlanDto
- FinancingDetailDto
- DocumentTemplateDto
- BrokerDto
- ChannelPartnerDto
- CommissionDto
- CommissionSettingsDto
- CommissionPayoutDto
- ChargeTemplateDto
- BuyerDto
- KycDocument
- BuilderDto
- BuilderPlanUpdateRequest
- BankDto
- BookingDto
- BookingLineItem
- LoanDetails
- AmenityMasterDto
- SearchResource
- PageZoneDto
- PageableObject
- SortObject
- PageZonePlanDto
- PageVillaDto
- FileReference
- Pageable
- PageUserDto
- Page
- UnitHierarchyRequest
- TenantSignupRequest
- BuilderResponse
- VerifyOtpRequest
- SendOtpRequest
- ReportSendRequest
- PageReminderScheduleDto
- ProjectAssignmentRequest
- ProjectAssetDto
- ZoneBatchRequest
- VillaBatchRequest
- TowerBatchRequest
- ProjectBulkUploadDataDto
- PagePaymentPlanDto
- PagePaymentPlanLineDto
- PageNotificationLogDto
- HandoverDocumentUploadRequest
- ScheduleHandoverRequest
- ScheduleVideoPossessionRequest
- UpsertNriComplianceItemRequest
- NriComplianceItemDto
- CreateChecklistItemDocumentRequest
- SignPossessionReceiptRequest
- BatchOfferLettersRequest
- BatchOfferLettersResponse
- FormSubmissionDto
- PageFormSubmissionDto
- PageFormDto
- ManualDemandRequest
- Configuration
- EnumConfigDto
- RecordPaymentRequest
- BuilderOnboardingRequest
- DocumentGenerationRequestDto
- LedgerEntryRequest
- PostJournalRequest
- JournalEntryDto
- LedgerEntryDto
- LedgerAccountDto
- FloorWithUnitsDto
- TowerHierarchyDto
- PageTdsDto
- RevenueReportDto
- ReportDownloadUrlResponse
- InventoryByProjectDto
- InventoryReportDto
- GeneralLedgerEntryDto
- BookingReportDto
- BuyerReportDto
- BuyerReportResponseDto
- DemandReceiptReportDto
- ProjectStatisticsDto
- BookingStatisticsDto
- ProjectStructureDto
- FloorUnitCountDto
- ProjectSummaryDto
- TowerSummaryDto
- ProjectStatsDto
- ProjectMilestoneViewDto
- PlatformDashboardStats
- KpiDashboardStats
- HighPriorityBuildersResponse
- PaymentPlanStatisticsDto
- NotificationLogSummaryDto
- MilestoneCompletionPreviewDto
- ProjectedCommissionDto
- ProjectedDemandDto
- MilestoneStatisticsDto
- BuilderDetails
- MeResponse
- SubscriptionDetails
- UserDetails
- HandoverStatsDto
- HandoverListRowDto
- StampDutyCalculationDto
- SnagStatisticsDto
- RegistrationTimelineDto
- AlertBannerDto
- CategoryProgressDto
- ChecklistItemSummaryDto
- HandoverDashboardDto
- HandoverSummaryStatsDto
- RegistrationKanbanCardDto
- RegistrationKanbanColumnDto
- NriComplianceDetailDto
- NriComplianceSummaryDto
- DlpWarrantyCoverageDto
- DlpWarrantySummaryDto
- HandoverOverviewDto
- TemplateVariable
- DemandStatisticsDto
- ChartDataDto
- DashboardReportDto
- MilestoneCompletionDto
- PendingActionDto
- ProjectDistributionDto
- QuickStatsDto
- RecentBookingDto
- UpcomingDemandDto
- EnumDto
- CommissionKpiDto
- KpiMetricDto
- CommissionPayoutKpiDto
- PageBuilderResponse
- PageBrokerDto
- DocumentPhaseConfigDto
- DocumentTemplateInfoDto
- DocumentTypeConfigDto
- UnitPriceBreakdownDto
- UnitPriceBreakdownLineItemDto
- AuditTrail
Update an existing buyer
PUT
/buyers/{id}
Maintainer:Not configured
Request
Authorization
JWT Bearer
Add the parameter
Authorization
to HeadersExample:
Authorization: ********************API Key
Add parameter in header
x-tenant-id
Example:
x-tenant-id: ********************or
Path Params
Body Params application/jsonRequired
Examples
Responses
🟢200
application/json
Body
🟠400
🟠401
🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/buyers/' \
--header 'Authorization: Bearer <token>' \
--header 'x-tenant-id: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"fullName": "string",
"email": "user@example.com",
"countryCode": "string",
"phone": "string",
"alternateCountryCode": "string",
"alternatePhone": "string",
"type": "INDIVIDUAL",
"dateOfBirth": "2019-08-24",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string",
"point": {
"latitude": 0,
"longitude": 0
}
},
"companyName": "string",
"companyType": "string",
"cin": "string",
"gstNumber": "string",
"signatoryName": "string",
"signatoryDesignation": "string",
"signatoryEmail": "string",
"signatoryCountryCode": "string",
"signatoryPhone": "string",
"kycDocuments": [
{
"type": "AADHAAR_CARD",
"documentNumber": "string",
"fileUrl": "string"
}
],
"kycStatus": "PENDING"
}'Response Response Example
200 - Success
{
"id": "66585d12-d811-47ba-bc85-a036b8907fc2",
"fullName": "Updated Name",
"email": "updatedEmail@gmail.com",
"countryCode": "91",
"phone": "5642355546",
"alternateCountryCode": "91",
"alternatePhone": "5465236654",
"type": "INDIVIDUAL",
"dateOfBirth": null,
"address": {
"city": "DELHI",
"country": "INDIA",
"line1": "Luxor street",
"line2": null,
"pincode": "500070",
"point": null,
"state": "DELHI"
},
"companyName": null,
"companyType": null,
"cin": null,
"gstNumber": null,
"signatoryName": null,
"signatoryDesignation": null,
"signatoryEmail": null,
"signatoryPhone": null,
"kycDocuments": [
{
"type": "AADHAAR_CARD",
"documentNumber": "652412545632",
"fileUrl": "7b4c0b3e-ec8b-4011-9201-7271231c57dd.pdf"
}
],
"kycStatus": "PENDING"
}
Modified at 2026-04-16 18:43:47