Site visits

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

GET/v1/visits

List site visits

Keyset-paginated visits in your scope (agent / booker, or visits on leads you can see).

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

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.
sortquery: string
Comma list of sort keys, "-" prefix for descending, e.g. -received_at.
viewquery: "upcoming" | "today" | "past" | "needs_feedback" | "all"
Default `all`; `today` uses the company’s day.
statusquery: string
Comma list of statuses.
agent_idquery: string
A member id, or `me`.
lead_idquery: Id
Opaque record id.
project_idquery: Id
Opaque record id.
property_idquery: Id
Opaque record id.
fromquery: string
scheduled_at ≥ (local date or instant).
toquery: string
scheduled_at ≤ (a local date includes the whole day).

Response · 200

datarequired: array of SiteVisit
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "scheduled",
      "phase": "upcoming",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string",
        "contact_id": "cmusrceel0000q7kaafxqi1om"
      },
      "agent": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "ends_at": "2026-10-06T05:30:00.000Z",
      "duration_min": 0,
      "visit_number": 0,
      "meeting_point": "string",
      "pickup": {
        "required": true,
        "address": "string",
        "at": "2026-10-06T05:30:00.000Z"
      },
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "items": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "sort_order": 0,
          "property": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "ref_code": "string",
            "title": "string",
            "listing_type": "string",
            "locality": "string"
          },
          "unit": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "unit_no": "string"
          },
          "planned_at": "2026-10-06T05:30:00.000Z",
          "reaction": "liked",
          "reasons": [
            "string"
          ],
          "remarks": "string"
        }
      ],
      "confirmed": {
        "at": "2026-10-06T05:30:00.000Z",
        "via": "link"
      },
      "otp": {
        "required": true,
        "verified_at": "2026-10-06T05:30:00.000Z",
        "method": "otp",
        "channel": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "attempts_left": 0,
        "locked": true,
        "resend_in_sec": 0
      },
      "check_in": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "accuracy_m": 0,
        "distance_m": 0,
        "far": true,
        "mock": true,
        "has_photo": true
      },
      "check_out": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "distance_m": 0,
        "mock": true
      },
      "completed_at": "2026-10-06T05:30:00.000Z",
      "actual_minutes": 0,
      "rating": 0,
      "notes": "string",
      "next_step": "string",
      "objections": [
        "string"
      ],
      "revisit_at": "2026-10-06T05:30:00.000Z",
      "feedback_at": "2026-10-06T05:30:00.000Z",
      "cancelled_reason": "string",
      "no_show_reason": "string",
      "reschedules": [
        {
          "from": "2026-10-06T05:30:00.000Z",
          "to": "2026-10-06T05:30:00.000Z",
          "reason": "string",
          "at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requests": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "at": "2026-10-06T05:30:00.000Z",
          "preferred_at": "2026-10-06T05:30:00.000Z",
          "note": "string",
          "status": "open"
        }
      ],
      "confirm_url": "string",
      "can_edit": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/visits

Schedule a site visit

A tour of up to 10 properties / units; the response warns about the agent’s nearby visits.

Access: API key with site_visits:write, or a member session. Permission site_visits.create.

Parameters

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

Request body

lead_idrequired: Id
Opaque record id.
scheduled_atrequired: string
duration_min: integer or null
agent_id: Id or null
Default: you, else the lead’s owner.
presales_id: Id or null
Default: the lead’s pre-sales owner.
project_id: Id or null
Opaque record id.
stops: array of SiteVisitStopInput
The tour, in visiting order.
meeting_point: string or null
pickup: object or null
pickup.addressrequired: string
pickup.at: string or null
partner_id: Id or null
Opaque record id.

Response · 201

datarequired: ScheduleVisitResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/visits' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_id":"cmusrceel0000q7kaafxqi1om","scheduled_at":"string","duration_min":15,"agent_id":"cmusrceel0000q7kaafxqi1om","presales_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","stops":[{"property_id":"cmusrceel0000q7kaafxqi1om","unit_id":"cmusrceel0000q7kaafxqi1om","at":"string"}],"meeting_point":"string","pickup":{"address":"string","at":"string"},"partner_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "visit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "scheduled",
      "phase": "upcoming",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string",
        "contact_id": "cmusrceel0000q7kaafxqi1om"
      },
      "agent": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "ends_at": "2026-10-06T05:30:00.000Z",
      "duration_min": 0,
      "visit_number": 0,
      "meeting_point": "string",
      "pickup": {
        "required": true,
        "address": "string",
        "at": "2026-10-06T05:30:00.000Z"
      },
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "items": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "sort_order": 0,
          "property": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "ref_code": "string",
            "title": "string",
            "listing_type": "string",
            "locality": "string"
          },
          "unit": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "unit_no": "string"
          },
          "planned_at": "2026-10-06T05:30:00.000Z",
          "reaction": "liked",
          "reasons": [
            "string"
          ],
          "remarks": "string"
        }
      ],
      "confirmed": {
        "at": "2026-10-06T05:30:00.000Z",
        "via": "link"
      },
      "otp": {
        "required": true,
        "verified_at": "2026-10-06T05:30:00.000Z",
        "method": "otp",
        "channel": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "attempts_left": 0,
        "locked": true,
        "resend_in_sec": 0
      },
      "check_in": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "accuracy_m": 0,
        "distance_m": 0,
        "far": true,
        "mock": true,
        "has_photo": true
      },
      "check_out": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "distance_m": 0,
        "mock": true
      },
      "completed_at": "2026-10-06T05:30:00.000Z",
      "actual_minutes": 0,
      "rating": 0,
      "notes": "string",
      "next_step": "string",
      "objections": [
        "string"
      ],
      "revisit_at": "2026-10-06T05:30:00.000Z",
      "feedback_at": "2026-10-06T05:30:00.000Z",
      "cancelled_reason": "string",
      "no_show_reason": "string",
      "reschedules": [
        {
          "from": "2026-10-06T05:30:00.000Z",
          "to": "2026-10-06T05:30:00.000Z",
          "reason": "string",
          "at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requests": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "at": "2026-10-06T05:30:00.000Z",
          "preferred_at": "2026-10-06T05:30:00.000Z",
          "note": "string",
          "status": "open"
        }
      ],
      "confirm_url": "string",
      "can_edit": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "conflicts": [
      {
        "visit_id": "cmusrceel0000q7kaafxqi1om",
        "kind": "overlap",
        "gap_min": 0,
        "scheduled_at": "2026-10-06T05:30:00.000Z",
        "ends_at": "2026-10-06T05:30:00.000Z",
        "lead_name": "string"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/visits/analytics

Visit analytics

Scheduled → done → deal, no-show, verified and feedback rates by agent, source or project.

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

Parameters

rangequery: "today" | "yesterday" | "7d" | "30d" | "90d" | "week" | …
Default 30d, on the company’s calendar.
fromquery: string
toquery: string
group_byquery: "agent" | "source" | "project"
agent_idquery: Id
Opaque record id.

Response · 200

datarequired: SiteVisitAnalytics
metarequired: object

Request

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

Response example

{
  "data": {
    "range": {
      "from": "2026-10-06T05:30:00.000Z",
      "to": "2026-10-06T05:30:00.000Z"
    },
    "group_by": "agent",
    "totals": {
      "scheduled": 0,
      "upcoming": 0,
      "completed": 0,
      "no_show": 0,
      "cancelled": 0,
      "verified": 0,
      "checked_in": 0,
      "feedback": 0,
      "revisits": 0,
      "deals": 0
    },
    "rates": {
      "completion_pct": 0,
      "no_show_pct": 0,
      "verified_pct": 0,
      "deal_pct": 0,
      "feedback_pct": 0
    },
    "funnel": [
      {
        "key": "scheduled",
        "label": "string",
        "count": 0
      }
    ],
    "breakdown": [
      {
        "key": "string",
        "label": "string",
        "scheduled": 0,
        "upcoming": 0,
        "completed": 0,
        "no_show": 0,
        "cancelled": 0,
        "verified": 0,
        "checked_in": 0,
        "feedback": 0,
        "revisits": 0,
        "deals": 0,
        "rates": {
          "completion_pct": 0,
          "no_show_pct": 0,
          "verified_pct": 0,
          "deal_pct": 0,
          "feedback_pct": 0
        }
      }
    ],
    "by_day": [
      {
        "date": "string",
        "scheduled": 0,
        "completed": 0,
        "no_show": 0
      }
    ],
    "truncated": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/visits/calendar

Visits calendar with agent lanes

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

Parameters

fromqueryrequired: string
First local day (YYYY-MM-DD) or instant.
toqueryrequired: string
Last local day (inclusive) or instant; up to 42 days.
agent_idsquery: string
statusquery: string

Response · 200

datarequired: SiteVisitCalendar
metarequired: object

Request

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

Response example

{
  "data": {
    "from": "2026-10-06T05:30:00.000Z",
    "to": "2026-10-06T05:30:00.000Z",
    "lanes": [
      {
        "agent": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "visits": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status": "scheduled",
            "phase": "upcoming",
            "lead": {
              "id": null,
              "ref": null,
              "name": null,
              "contact_id": null
            },
            "agent": {
              "id": null,
              "name": null
            },
            "presales": {
              "id": null,
              "name": null
            },
            "created_by_id": "cmusrceel0000q7kaafxqi1om",
            "project": {
              "id": null,
              "name": null
            },
            "scheduled_at": "2026-10-06T05:30:00.000Z",
            "ends_at": "2026-10-06T05:30:00.000Z",
            "duration_min": 0,
            "visit_number": 0,
            "meeting_point": "string",
            "pickup": {
              "required": null,
              "address": null,
              "at": null
            },
            "partner_id": "cmusrceel0000q7kaafxqi1om",
            "items": [
              null
            ],
            "confirmed": {
              "at": null,
              "via": null
            },
            "otp": {
              "required": null,
              "verified_at": null,
              "method": null,
              "channel": null,
              "sent_at": null,
              "expires_at": null,
              "attempts_left": null,
              "locked": null,
              "resend_in_sec": null
            },
            "check_in": {
              "at": null,
              "lat": null,
              "lng": null,
              "accuracy_m": null,
              "distance_m": null,
              "far": null,
              "mock": null,
              "has_photo": null
            },
            "check_out": {
              "at": null,
              "lat": null,
              "lng": null,
              "distance_m": null,
              "mock": null
            },
            "completed_at": "2026-10-06T05:30:00.000Z",
            "actual_minutes": 0,
            "rating": 0,
            "notes": "string",
            "next_step": "string",
            "objections": [
              null
            ],
            "revisit_at": "2026-10-06T05:30:00.000Z",
            "feedback_at": "2026-10-06T05:30:00.000Z",
            "cancelled_reason": "string",
            "no_show_reason": "string",
            "reschedules": [
              null
            ],
            "requests": [
              null
            ],
            "confirm_url": "string",
            "can_edit": true,
            "created_at": "2026-10-06T05:30:00.000Z",
            "updated_at": "2026-10-06T05:30:00.000Z"
          }
        ]
      }
    ],
    "truncated": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/visits/conflicts

The agent’s nearby visits

Visits overlapping the slot or within the travel buffer (live warnings in the booking form).

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

Parameters

agent_idqueryrequired: Id
Opaque record id.
scheduled_atqueryrequired: string
duration_minquery: integer
exclude_idquery: Id
Opaque record id.

Response · 200

datarequired: array of SiteVisitConflict
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "visit_id": "cmusrceel0000q7kaafxqi1om",
      "kind": "overlap",
      "gap_min": 0,
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "ends_at": "2026-10-06T05:30:00.000Z",
      "lead_name": "string"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/visits/settings

Site visit settings

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

Response · 200

datarequired: SiteVisitSettings
metarequired: object

Request

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

Response example

{
  "data": {
    "default_duration_min": 0,
    "travel_buffer_min": 0,
    "otp": {
      "required": "off",
      "project_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "source_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "partner_visits": true,
      "fallback": "show_agent"
    },
    "check_in": {
      "radius_m": 0
    },
    "reminders": {
      "confirmation": true,
      "client_24h": true,
      "client_2h": true,
      "agent_minutes_before": 0,
      "owner_notice": true,
      "overdue_minutes": 0
    },
    "feedback_due_hours": 0,
    "no_show_offer": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/visits/settings

Change site visit settings

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

Request body

default_duration_min: integer
travel_buffer_min: integer
otp: object
otp.required: "off" | "all" | "rules"
otp.project_ids: array of Id
Opaque record id.
otp.source_ids: array of Id
Opaque record id.
otp.partner_visits: boolean
otp.fallback: "show_agent" | "none"
check_in: object
check_in.radius_m: integer
reminders: object
reminders.confirmation: boolean
reminders.client_24h: boolean
reminders.client_2h: boolean
reminders.agent_minutes_before: integer
reminders.owner_notice: boolean
reminders.overdue_minutes: integer
feedback_due_hours: integer
no_show_offer: boolean

Response · 200

datarequired: SiteVisitSettings
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/visits/settings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"default_duration_min":15,"travel_buffer_min":0,"otp":{"required":"off","project_ids":["cmusrceel0000q7kaafxqi1om"],"source_ids":["cmusrceel0000q7kaafxqi1om"],"partner_visits":true,"fallback":"show_agent"},"check_in":{"radius_m":50},"reminders":{"confirmation":true,"client_24h":true,"client_2h":true,"agent_minutes_before":0,"owner_notice":true,"overdue_minutes":0},"feedback_due_hours":1,"no_show_offer":true}'

Response example

{
  "data": {
    "default_duration_min": 0,
    "travel_buffer_min": 0,
    "otp": {
      "required": "off",
      "project_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "source_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "partner_visits": true,
      "fallback": "show_agent"
    },
    "check_in": {
      "radius_m": 0
    },
    "reminders": {
      "confirmation": true,
      "client_24h": true,
      "client_2h": true,
      "agent_minutes_before": 0,
      "owner_notice": true,
      "overdue_minutes": 0
    },
    "feedback_due_hours": 0,
    "no_show_offer": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/visits/{id}

A site visit

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: SiteVisit
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "scheduled",
    "phase": "upcoming",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string",
      "contact_id": "cmusrceel0000q7kaafxqi1om"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "presales": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "scheduled_at": "2026-10-06T05:30:00.000Z",
    "ends_at": "2026-10-06T05:30:00.000Z",
    "duration_min": 0,
    "visit_number": 0,
    "meeting_point": "string",
    "pickup": {
      "required": true,
      "address": "string",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "partner_id": "cmusrceel0000q7kaafxqi1om",
    "items": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "sort_order": 0,
        "property": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref_code": "string",
          "title": "string",
          "listing_type": "string",
          "locality": "string"
        },
        "unit": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "unit_no": "string"
        },
        "planned_at": "2026-10-06T05:30:00.000Z",
        "reaction": "liked",
        "reasons": [
          "string"
        ],
        "remarks": "string"
      }
    ],
    "confirmed": {
      "at": "2026-10-06T05:30:00.000Z",
      "via": "link"
    },
    "otp": {
      "required": true,
      "verified_at": "2026-10-06T05:30:00.000Z",
      "method": "otp",
      "channel": "string",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "attempts_left": 0,
      "locked": true,
      "resend_in_sec": 0
    },
    "check_in": {
      "at": "2026-10-06T05:30:00.000Z",
      "lat": 0,
      "lng": 0,
      "accuracy_m": 0,
      "distance_m": 0,
      "far": true,
      "mock": true,
      "has_photo": true
    },
    "check_out": {
      "at": "2026-10-06T05:30:00.000Z",
      "lat": 0,
      "lng": 0,
      "distance_m": 0,
      "mock": true
    },
    "completed_at": "2026-10-06T05:30:00.000Z",
    "actual_minutes": 0,
    "rating": 0,
    "notes": "string",
    "next_step": "string",
    "objections": [
      "string"
    ],
    "revisit_at": "2026-10-06T05:30:00.000Z",
    "feedback_at": "2026-10-06T05:30:00.000Z",
    "cancelled_reason": "string",
    "no_show_reason": "string",
    "reschedules": [
      {
        "from": "2026-10-06T05:30:00.000Z",
        "to": "2026-10-06T05:30:00.000Z",
        "reason": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "requests": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "at": "2026-10-06T05:30:00.000Z",
        "preferred_at": "2026-10-06T05:30:00.000Z",
        "note": "string",
        "status": "open"
      }
    ],
    "confirm_url": "string",
    "can_edit": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/visits/{id}

Change a visit

Agent, pre-sales, project, tour, meeting point, pickup, length or partner (the time: reschedule).

Access: API key with site_visits:write, or a member session. Permission site_visits.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

agent_id: Id or null
Opaque record id.
presales_id: Id or null
Opaque record id.
project_id: Id or null
Opaque record id.
stops: array of SiteVisitStopInput
meeting_point: string or null
pickup: object or null
pickup.addressrequired: string
pickup.at: string or null
duration_min: integer
partner_id: Id or null
Opaque record id.

Response · 200

datarequired: ScheduleVisitResult
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/visits/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"agent_id":"cmusrceel0000q7kaafxqi1om","presales_id":"cmusrceel0000q7kaafxqi1om","project_id":"cmusrceel0000q7kaafxqi1om","stops":[{"property_id":"cmusrceel0000q7kaafxqi1om","unit_id":"cmusrceel0000q7kaafxqi1om","at":"string"}],"meeting_point":"string","pickup":{"address":"string","at":"string"},"duration_min":15,"partner_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "visit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "scheduled",
      "phase": "upcoming",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string",
        "contact_id": "cmusrceel0000q7kaafxqi1om"
      },
      "agent": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "ends_at": "2026-10-06T05:30:00.000Z",
      "duration_min": 0,
      "visit_number": 0,
      "meeting_point": "string",
      "pickup": {
        "required": true,
        "address": "string",
        "at": "2026-10-06T05:30:00.000Z"
      },
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "items": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "sort_order": 0,
          "property": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "ref_code": "string",
            "title": "string",
            "listing_type": "string",
            "locality": "string"
          },
          "unit": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "unit_no": "string"
          },
          "planned_at": "2026-10-06T05:30:00.000Z",
          "reaction": "liked",
          "reasons": [
            "string"
          ],
          "remarks": "string"
        }
      ],
      "confirmed": {
        "at": "2026-10-06T05:30:00.000Z",
        "via": "link"
      },
      "otp": {
        "required": true,
        "verified_at": "2026-10-06T05:30:00.000Z",
        "method": "otp",
        "channel": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "attempts_left": 0,
        "locked": true,
        "resend_in_sec": 0
      },
      "check_in": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "accuracy_m": 0,
        "distance_m": 0,
        "far": true,
        "mock": true,
        "has_photo": true
      },
      "check_out": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "distance_m": 0,
        "mock": true
      },
      "completed_at": "2026-10-06T05:30:00.000Z",
      "actual_minutes": 0,
      "rating": 0,
      "notes": "string",
      "next_step": "string",
      "objections": [
        "string"
      ],
      "revisit_at": "2026-10-06T05:30:00.000Z",
      "feedback_at": "2026-10-06T05:30:00.000Z",
      "cancelled_reason": "string",
      "no_show_reason": "string",
      "reschedules": [
        {
          "from": "2026-10-06T05:30:00.000Z",
          "to": "2026-10-06T05:30:00.000Z",
          "reason": "string",
          "at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requests": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "at": "2026-10-06T05:30:00.000Z",
          "preferred_at": "2026-10-06T05:30:00.000Z",
          "note": "string",
          "status": "open"
        }
      ],
      "confirm_url": "string",
      "can_edit": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "conflicts": [
      {
        "visit_id": "cmusrceel0000q7kaafxqi1om",
        "kind": "overlap",
        "gap_min": 0,
        "scheduled_at": "2026-10-06T05:30:00.000Z",
        "ends_at": "2026-10-06T05:30:00.000Z",
        "lead_name": "string"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/visits/{id}/cancel

Cancel a visit

Access: API key with site_visits:write, or a member session. Permission site_visits.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string

Response · 200

datarequired: SiteVisit
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/visits/{id}/cancel' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "scheduled",
    "phase": "upcoming",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string",
      "contact_id": "cmusrceel0000q7kaafxqi1om"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "presales": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "scheduled_at": "2026-10-06T05:30:00.000Z",
    "ends_at": "2026-10-06T05:30:00.000Z",
    "duration_min": 0,
    "visit_number": 0,
    "meeting_point": "string",
    "pickup": {
      "required": true,
      "address": "string",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "partner_id": "cmusrceel0000q7kaafxqi1om",
    "items": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "sort_order": 0,
        "property": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref_code": "string",
          "title": "string",
          "listing_type": "string",
          "locality": "string"
        },
        "unit": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "unit_no": "string"
        },
        "planned_at": "2026-10-06T05:30:00.000Z",
        "reaction": "liked",
        "reasons": [
          "string"
        ],
        "remarks": "string"
      }
    ],
    "confirmed": {
      "at": "2026-10-06T05:30:00.000Z",
      "via": "link"
    },
    "otp": {
      "required": true,
      "verified_at": "2026-10-06T05:30:00.000Z",
      "method": "otp",
      "channel": "string",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "attempts_left": 0,
      "locked": true,
      "resend_in_sec": 0
    },
    "check_in": {
      "at": "2026-10-06T05:30:00.000Z",
      "lat": 0,
      "lng": 0,
      "accuracy_m": 0,
      "distance_m": 0,
      "far": true,
      "mock": true,
      "has_photo": true
    },
    "check_out": {
      "at": "2026-10-06T05:30:00.000Z",
      "lat": 0,
      "lng": 0,
      "distance_m": 0,
      "mock": true
    },
    "completed_at": "2026-10-06T05:30:00.000Z",
    "actual_minutes": 0,
    "rating": 0,
    "notes": "string",
    "next_step": "string",
    "objections": [
      "string"
    ],
    "revisit_at": "2026-10-06T05:30:00.000Z",
    "feedback_at": "2026-10-06T05:30:00.000Z",
    "cancelled_reason": "string",
    "no_show_reason": "string",
    "reschedules": [
      {
        "from": "2026-10-06T05:30:00.000Z",
        "to": "2026-10-06T05:30:00.000Z",
        "reason": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "requests": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "at": "2026-10-06T05:30:00.000Z",
        "preferred_at": "2026-10-06T05:30:00.000Z",
        "note": "string",
        "status": "open"
      }
    ],
    "confirm_url": "string",
    "can_edit": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/visits/{id}/certificate

The visit certificate

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: SiteVisitCertificate
metarequired: object

Request

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

Response example

{
  "data": {
    "visit_id": "cmusrceel0000q7kaafxqi1om",
    "company": {
      "name": "string"
    },
    "lead": {
      "ref": "string",
      "name": "string",
      "phone": "string"
    },
    "agent": "string",
    "project": "string",
    "stops": [
      "string"
    ],
    "scheduled_at": "2026-10-06T05:30:00.000Z",
    "check_in": {
      "at": "2026-10-06T05:30:00.000Z",
      "lat": 0,
      "lng": 0,
      "distance_m": 0,
      "mock": true
    },
    "check_out": {
      "at": "2026-10-06T05:30:00.000Z",
      "lat": 0,
      "lng": 0
    },
    "completed_at": "2026-10-06T05:30:00.000Z",
    "duration_min": 0,
    "verification": {
      "method": "otp",
      "channel": "string",
      "verified_at": "2026-10-06T05:30:00.000Z",
      "override_reason": "string"
    },
    "issued_at": "2026-10-06T05:30:00.000Z",
    "seal": "string",
    "verify_url": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/visits/{id}/check-in

Check in at the site

GPS + optional photo and OTP; warns beyond the company radius.

Access: API key with site_visits:write, or a member session. Permission site_visits.edit.

Parameters

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

Request body

latrequired: number
lngrequired: number
accuracy_m: number or null
mock_location: boolean or null
The phone reported a mock (fake) location.
photo_key: string or null
Key from POST …/photos after the upload.
client_key: string or null
Offline queue key: sending the same key again returns the stored capture.
captured_at: DateTime or null
Phone time of the capture (kept when plausible).
otp: string or null

Response · 200

datarequired: VisitCheckInResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/visits/{id}/check-in' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"lat":0,"lng":0,"accuracy_m":0,"mock_location":true,"photo_key":"string","client_key":"string","captured_at":"2026-10-06T05:30:00.000Z","otp":"string"}'

Response example

{
  "data": {
    "visit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "scheduled",
      "phase": "upcoming",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string",
        "contact_id": "cmusrceel0000q7kaafxqi1om"
      },
      "agent": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "ends_at": "2026-10-06T05:30:00.000Z",
      "duration_min": 0,
      "visit_number": 0,
      "meeting_point": "string",
      "pickup": {
        "required": true,
        "address": "string",
        "at": "2026-10-06T05:30:00.000Z"
      },
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "items": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "sort_order": 0,
          "property": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "ref_code": "string",
            "title": "string",
            "listing_type": "string",
            "locality": "string"
          },
          "unit": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "unit_no": "string"
          },
          "planned_at": "2026-10-06T05:30:00.000Z",
          "reaction": "liked",
          "reasons": [
            "string"
          ],
          "remarks": "string"
        }
      ],
      "confirmed": {
        "at": "2026-10-06T05:30:00.000Z",
        "via": "link"
      },
      "otp": {
        "required": true,
        "verified_at": "2026-10-06T05:30:00.000Z",
        "method": "otp",
        "channel": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "attempts_left": 0,
        "locked": true,
        "resend_in_sec": 0
      },
      "check_in": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "accuracy_m": 0,
        "distance_m": 0,
        "far": true,
        "mock": true,
        "has_photo": true
      },
      "check_out": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "distance_m": 0,
        "mock": true
      },
      "completed_at": "2026-10-06T05:30:00.000Z",
      "actual_minutes": 0,
      "rating": 0,
      "notes": "string",
      "next_step": "string",
      "objections": [
        "string"
      ],
      "revisit_at": "2026-10-06T05:30:00.000Z",
      "feedback_at": "2026-10-06T05:30:00.000Z",
      "cancelled_reason": "string",
      "no_show_reason": "string",
      "reschedules": [
        {
          "from": "2026-10-06T05:30:00.000Z",
          "to": "2026-10-06T05:30:00.000Z",
          "reason": "string",
          "at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requests": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "at": "2026-10-06T05:30:00.000Z",
          "preferred_at": "2026-10-06T05:30:00.000Z",
          "note": "string",
          "status": "open"
        }
      ],
      "confirm_url": "string",
      "can_edit": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "warnings": [
      "far_from_site"
    ],
    "distance_m": 0,
    "replayed": true,
    "otp": {
      "verified": true,
      "reason": "invalid",
      "attempts_left": 0
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/visits/{id}/check-out

Check out and finish the visit

Access: API key with site_visits:write, or a member session. Permission site_visits.edit.

Parameters

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

Request body

lat: number
lng: number
accuracy_m: number or null
mock_location: boolean or null
The phone reported a mock (fake) location.
photo_key: string or null
Key from POST …/photos after the upload.
client_key: string or null
Offline queue key: sending the same key again returns the stored capture.
captured_at: DateTime or null
Phone time of the capture (kept when plausible).
override_reason: string or null
Finish without the required OTP (site_visits.override_otp, audited).

Response · 200

datarequired: VisitCheckOutResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/visits/{id}/check-out' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"lat":0,"lng":0,"accuracy_m":0,"mock_location":true,"photo_key":"string","client_key":"string","captured_at":"2026-10-06T05:30:00.000Z","override_reason":"string"}'

Response example

{
  "data": {
    "visit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "scheduled",
      "phase": "upcoming",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string",
        "contact_id": "cmusrceel0000q7kaafxqi1om"
      },
      "agent": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "ends_at": "2026-10-06T05:30:00.000Z",
      "duration_min": 0,
      "visit_number": 0,
      "meeting_point": "string",
      "pickup": {
        "required": true,
        "address": "string",
        "at": "2026-10-06T05:30:00.000Z"
      },
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "items": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "sort_order": 0,
          "property": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "ref_code": "string",
            "title": "string",
            "listing_type": "string",
            "locality": "string"
          },
          "unit": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "unit_no": "string"
          },
          "planned_at": "2026-10-06T05:30:00.000Z",
          "reaction": "liked",
          "reasons": [
            "string"
          ],
          "remarks": "string"
        }
      ],
      "confirmed": {
        "at": "2026-10-06T05:30:00.000Z",
        "via": "link"
      },
      "otp": {
        "required": true,
        "verified_at": "2026-10-06T05:30:00.000Z",
        "method": "otp",
        "channel": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "attempts_left": 0,
        "locked": true,
        "resend_in_sec": 0
      },
      "check_in": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "accuracy_m": 0,
        "distance_m": 0,
        "far": true,
        "mock": true,
        "has_photo": true
      },
      "check_out": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "distance_m": 0,
        "mock": true
      },
      "completed_at": "2026-10-06T05:30:00.000Z",
      "actual_minutes": 0,
      "rating": 0,
      "notes": "string",
      "next_step": "string",
      "objections": [
        "string"
      ],
      "revisit_at": "2026-10-06T05:30:00.000Z",
      "feedback_at": "2026-10-06T05:30:00.000Z",
      "cancelled_reason": "string",
      "no_show_reason": "string",
      "reschedules": [
        {
          "from": "2026-10-06T05:30:00.000Z",
          "to": "2026-10-06T05:30:00.000Z",
          "reason": "string",
          "at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requests": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "at": "2026-10-06T05:30:00.000Z",
          "preferred_at": "2026-10-06T05:30:00.000Z",
          "note": "string",
          "status": "open"
        }
      ],
      "confirm_url": "string",
      "can_edit": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "replayed": true,
    "distance_m": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/visits/{id}/complete

Mark the visit as done

Without a GPS capture (web). Needs the OTP when required, or an override.

Access: API key with site_visits:write, or a member session. Permission site_visits.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

override_reason: string or null
Finish without the required OTP (site_visits.override_otp, audited).
completed_at: string or null

Response · 200

datarequired: SiteVisit
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/visits/{id}/complete' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"override_reason":"string","completed_at":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "scheduled",
    "phase": "upcoming",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string",
      "contact_id": "cmusrceel0000q7kaafxqi1om"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "presales": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "scheduled_at": "2026-10-06T05:30:00.000Z",
    "ends_at": "2026-10-06T05:30:00.000Z",
    "duration_min": 0,
    "visit_number": 0,
    "meeting_point": "string",
    "pickup": {
      "required": true,
      "address": "string",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "partner_id": "cmusrceel0000q7kaafxqi1om",
    "items": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "sort_order": 0,
        "property": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref_code": "string",
          "title": "string",
          "listing_type": "string",
          "locality": "string"
        },
        "unit": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "unit_no": "string"
        },
        "planned_at": "2026-10-06T05:30:00.000Z",
        "reaction": "liked",
        "reasons": [
          "string"
        ],
        "remarks": "string"
      }
    ],
    "confirmed": {
      "at": "2026-10-06T05:30:00.000Z",
      "via": "link"
    },
    "otp": {
      "required": true,
      "verified_at": "2026-10-06T05:30:00.000Z",
      "method": "otp",
      "channel": "string",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "attempts_left": 0,
      "locked": true,
      "resend_in_sec": 0
    },
    "check_in": {
      "at": "2026-10-06T05:30:00.000Z",
      "lat": 0,
      "lng": 0,
      "accuracy_m": 0,
      "distance_m": 0,
      "far": true,
      "mock": true,
      "has_photo": true
    },
    "check_out": {
      "at": "2026-10-06T05:30:00.000Z",
      "lat": 0,
      "lng": 0,
      "distance_m": 0,
      "mock": true
    },
    "completed_at": "2026-10-06T05:30:00.000Z",
    "actual_minutes": 0,
    "rating": 0,
    "notes": "string",
    "next_step": "string",
    "objections": [
      "string"
    ],
    "revisit_at": "2026-10-06T05:30:00.000Z",
    "feedback_at": "2026-10-06T05:30:00.000Z",
    "cancelled_reason": "string",
    "no_show_reason": "string",
    "reschedules": [
      {
        "from": "2026-10-06T05:30:00.000Z",
        "to": "2026-10-06T05:30:00.000Z",
        "reason": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "requests": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "at": "2026-10-06T05:30:00.000Z",
        "preferred_at": "2026-10-06T05:30:00.000Z",
        "note": "string",
        "status": "open"
      }
    ],
    "confirm_url": "string",
    "can_edit": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/visits/{id}/confirm

Mark the visit confirmed

The client confirmed on the phone (the link confirms by itself).

Access: API key with site_visits:write, or a member session. Permission site_visits.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

No fields.

Response · 200

datarequired: SiteVisit
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/visits/{id}/confirm' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "scheduled",
    "phase": "upcoming",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string",
      "contact_id": "cmusrceel0000q7kaafxqi1om"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "presales": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "scheduled_at": "2026-10-06T05:30:00.000Z",
    "ends_at": "2026-10-06T05:30:00.000Z",
    "duration_min": 0,
    "visit_number": 0,
    "meeting_point": "string",
    "pickup": {
      "required": true,
      "address": "string",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "partner_id": "cmusrceel0000q7kaafxqi1om",
    "items": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "sort_order": 0,
        "property": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref_code": "string",
          "title": "string",
          "listing_type": "string",
          "locality": "string"
        },
        "unit": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "unit_no": "string"
        },
        "planned_at": "2026-10-06T05:30:00.000Z",
        "reaction": "liked",
        "reasons": [
          "string"
        ],
        "remarks": "string"
      }
    ],
    "confirmed": {
      "at": "2026-10-06T05:30:00.000Z",
      "via": "link"
    },
    "otp": {
      "required": true,
      "verified_at": "2026-10-06T05:30:00.000Z",
      "method": "otp",
      "channel": "string",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "attempts_left": 0,
      "locked": true,
      "resend_in_sec": 0
    },
    "check_in": {
      "at": "2026-10-06T05:30:00.000Z",
      "lat": 0,
      "lng": 0,
      "accuracy_m": 0,
      "distance_m": 0,
      "far": true,
      "mock": true,
      "has_photo": true
    },
    "check_out": {
      "at": "2026-10-06T05:30:00.000Z",
      "lat": 0,
      "lng": 0,
      "distance_m": 0,
      "mock": true
    },
    "completed_at": "2026-10-06T05:30:00.000Z",
    "actual_minutes": 0,
    "rating": 0,
    "notes": "string",
    "next_step": "string",
    "objections": [
      "string"
    ],
    "revisit_at": "2026-10-06T05:30:00.000Z",
    "feedback_at": "2026-10-06T05:30:00.000Z",
    "cancelled_reason": "string",
    "no_show_reason": "string",
    "reschedules": [
      {
        "from": "2026-10-06T05:30:00.000Z",
        "to": "2026-10-06T05:30:00.000Z",
        "reason": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "requests": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "at": "2026-10-06T05:30:00.000Z",
        "preferred_at": "2026-10-06T05:30:00.000Z",
        "note": "string",
        "status": "open"
      }
    ],
    "confirm_url": "string",
    "can_edit": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/visits/{id}/feedback

Record visit feedback

Per property (liked / maybe / disliked + reasons), interest, objections and the next step.

Access: API key with site_visits:write, or a member session. Permission site_visits.edit.

Parameters

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

Request body

rating: integer or null
items: array of object
items[].item_idrequired: Id
Opaque record id.
items[].reactionrequired: VisitReaction
items[].reasons: array of VisitFeedbackReason
items[].remarks: string or null
objections: array of VisitFeedbackReason
next_step: VisitNextStep or null
revisit_at: string or null
notes: string or null

Response · 200

datarequired: SiteVisit
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/visits/{id}/feedback' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"rating":1,"items":[{"item_id":"cmusrceel0000q7kaafxqi1om","reaction":"liked","reasons":["price"],"remarks":"string"}],"objections":["price"],"next_step":"negotiation","revisit_at":"string","notes":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "scheduled",
    "phase": "upcoming",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string",
      "contact_id": "cmusrceel0000q7kaafxqi1om"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "presales": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "created_by_id": "cmusrceel0000q7kaafxqi1om",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "scheduled_at": "2026-10-06T05:30:00.000Z",
    "ends_at": "2026-10-06T05:30:00.000Z",
    "duration_min": 0,
    "visit_number": 0,
    "meeting_point": "string",
    "pickup": {
      "required": true,
      "address": "string",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "partner_id": "cmusrceel0000q7kaafxqi1om",
    "items": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "sort_order": 0,
        "property": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "ref_code": "string",
          "title": "string",
          "listing_type": "string",
          "locality": "string"
        },
        "unit": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "unit_no": "string"
        },
        "planned_at": "2026-10-06T05:30:00.000Z",
        "reaction": "liked",
        "reasons": [
          "string"
        ],
        "remarks": "string"
      }
    ],
    "confirmed": {
      "at": "2026-10-06T05:30:00.000Z",
      "via": "link"
    },
    "otp": {
      "required": true,
      "verified_at": "2026-10-06T05:30:00.000Z",
      "method": "otp",
      "channel": "string",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "attempts_left": 0,
      "locked": true,
      "resend_in_sec": 0
    },
    "check_in": {
      "at": "2026-10-06T05:30:00.000Z",
      "lat": 0,
      "lng": 0,
      "accuracy_m": 0,
      "distance_m": 0,
      "far": true,
      "mock": true,
      "has_photo": true
    },
    "check_out": {
      "at": "2026-10-06T05:30:00.000Z",
      "lat": 0,
      "lng": 0,
      "distance_m": 0,
      "mock": true
    },
    "completed_at": "2026-10-06T05:30:00.000Z",
    "actual_minutes": 0,
    "rating": 0,
    "notes": "string",
    "next_step": "string",
    "objections": [
      "string"
    ],
    "revisit_at": "2026-10-06T05:30:00.000Z",
    "feedback_at": "2026-10-06T05:30:00.000Z",
    "cancelled_reason": "string",
    "no_show_reason": "string",
    "reschedules": [
      {
        "from": "2026-10-06T05:30:00.000Z",
        "to": "2026-10-06T05:30:00.000Z",
        "reason": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "requests": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "at": "2026-10-06T05:30:00.000Z",
        "preferred_at": "2026-10-06T05:30:00.000Z",
        "note": "string",
        "status": "open"
      }
    ],
    "confirm_url": "string",
    "can_edit": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/visits/{id}/no-show

Mark a no-show

Sends the client a reschedule offer unless switched off.

Access: API key with site_visits:write, or a member session. Permission site_visits.edit.

Parameters

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

Request body

reasonrequired: string
offer_reschedule: boolean or null
Default: the company setting (on).

Response · 200

datarequired: VisitNoShowResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/visits/{id}/no-show' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string","offer_reschedule":true}'

Response example

{
  "data": {
    "visit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "scheduled",
      "phase": "upcoming",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string",
        "contact_id": "cmusrceel0000q7kaafxqi1om"
      },
      "agent": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "ends_at": "2026-10-06T05:30:00.000Z",
      "duration_min": 0,
      "visit_number": 0,
      "meeting_point": "string",
      "pickup": {
        "required": true,
        "address": "string",
        "at": "2026-10-06T05:30:00.000Z"
      },
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "items": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "sort_order": 0,
          "property": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "ref_code": "string",
            "title": "string",
            "listing_type": "string",
            "locality": "string"
          },
          "unit": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "unit_no": "string"
          },
          "planned_at": "2026-10-06T05:30:00.000Z",
          "reaction": "liked",
          "reasons": [
            "string"
          ],
          "remarks": "string"
        }
      ],
      "confirmed": {
        "at": "2026-10-06T05:30:00.000Z",
        "via": "link"
      },
      "otp": {
        "required": true,
        "verified_at": "2026-10-06T05:30:00.000Z",
        "method": "otp",
        "channel": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "attempts_left": 0,
        "locked": true,
        "resend_in_sec": 0
      },
      "check_in": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "accuracy_m": 0,
        "distance_m": 0,
        "far": true,
        "mock": true,
        "has_photo": true
      },
      "check_out": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "distance_m": 0,
        "mock": true
      },
      "completed_at": "2026-10-06T05:30:00.000Z",
      "actual_minutes": 0,
      "rating": 0,
      "notes": "string",
      "next_step": "string",
      "objections": [
        "string"
      ],
      "revisit_at": "2026-10-06T05:30:00.000Z",
      "feedback_at": "2026-10-06T05:30:00.000Z",
      "cancelled_reason": "string",
      "no_show_reason": "string",
      "reschedules": [
        {
          "from": "2026-10-06T05:30:00.000Z",
          "to": "2026-10-06T05:30:00.000Z",
          "reason": "string",
          "at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requests": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "at": "2026-10-06T05:30:00.000Z",
          "preferred_at": "2026-10-06T05:30:00.000Z",
          "note": "string",
          "status": "open"
        }
      ],
      "confirm_url": "string",
      "can_edit": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "offer": {
      "status": "queued",
      "channel": "string",
      "reason": "string"
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/visits/{id}/otp

Send the visit code to the client

WhatsApp / SMS / email through the send pipeline; 30-second resend gap, 5 codes per visit.

Access: API key with site_visits:write, or a member session. Permission site_visits.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

No fields.

Response · 200

datarequired: SendVisitOtpResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/visits/{id}/otp' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response example

{
  "data": {
    "visit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "scheduled",
      "phase": "upcoming",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string",
        "contact_id": "cmusrceel0000q7kaafxqi1om"
      },
      "agent": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "ends_at": "2026-10-06T05:30:00.000Z",
      "duration_min": 0,
      "visit_number": 0,
      "meeting_point": "string",
      "pickup": {
        "required": true,
        "address": "string",
        "at": "2026-10-06T05:30:00.000Z"
      },
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "items": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "sort_order": 0,
          "property": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "ref_code": "string",
            "title": "string",
            "listing_type": "string",
            "locality": "string"
          },
          "unit": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "unit_no": "string"
          },
          "planned_at": "2026-10-06T05:30:00.000Z",
          "reaction": "liked",
          "reasons": [
            "string"
          ],
          "remarks": "string"
        }
      ],
      "confirmed": {
        "at": "2026-10-06T05:30:00.000Z",
        "via": "link"
      },
      "otp": {
        "required": true,
        "verified_at": "2026-10-06T05:30:00.000Z",
        "method": "otp",
        "channel": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "attempts_left": 0,
        "locked": true,
        "resend_in_sec": 0
      },
      "check_in": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "accuracy_m": 0,
        "distance_m": 0,
        "far": true,
        "mock": true,
        "has_photo": true
      },
      "check_out": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "distance_m": 0,
        "mock": true
      },
      "completed_at": "2026-10-06T05:30:00.000Z",
      "actual_minutes": 0,
      "rating": 0,
      "notes": "string",
      "next_step": "string",
      "objections": [
        "string"
      ],
      "revisit_at": "2026-10-06T05:30:00.000Z",
      "feedback_at": "2026-10-06T05:30:00.000Z",
      "cancelled_reason": "string",
      "no_show_reason": "string",
      "reschedules": [
        {
          "from": "2026-10-06T05:30:00.000Z",
          "to": "2026-10-06T05:30:00.000Z",
          "reason": "string",
          "at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requests": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "at": "2026-10-06T05:30:00.000Z",
          "preferred_at": "2026-10-06T05:30:00.000Z",
          "note": "string",
          "status": "open"
        }
      ],
      "confirm_url": "string",
      "can_edit": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "channel": "string",
    "shown_code": "string",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "resend_in_sec": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/visits/{id}/otp/verify

Check the client’s visit code

A wrong code answers `verified: false` with the attempts left; the third locks the code.

Access: API key with site_visits:write, or a member session. Permission site_visits.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

coderequired: string

Response · 200

datarequired: VerifyVisitOtpResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/visits/{id}/otp/verify' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"code":"string"}'

Response example

{
  "data": {
    "result": {
      "verified": true,
      "reason": "invalid",
      "attempts_left": 0
    },
    "visit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "scheduled",
      "phase": "upcoming",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string",
        "contact_id": "cmusrceel0000q7kaafxqi1om"
      },
      "agent": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "ends_at": "2026-10-06T05:30:00.000Z",
      "duration_min": 0,
      "visit_number": 0,
      "meeting_point": "string",
      "pickup": {
        "required": true,
        "address": "string",
        "at": "2026-10-06T05:30:00.000Z"
      },
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "items": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "sort_order": 0,
          "property": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "ref_code": "string",
            "title": "string",
            "listing_type": "string",
            "locality": "string"
          },
          "unit": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "unit_no": "string"
          },
          "planned_at": "2026-10-06T05:30:00.000Z",
          "reaction": "liked",
          "reasons": [
            "string"
          ],
          "remarks": "string"
        }
      ],
      "confirmed": {
        "at": "2026-10-06T05:30:00.000Z",
        "via": "link"
      },
      "otp": {
        "required": true,
        "verified_at": "2026-10-06T05:30:00.000Z",
        "method": "otp",
        "channel": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "attempts_left": 0,
        "locked": true,
        "resend_in_sec": 0
      },
      "check_in": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "accuracy_m": 0,
        "distance_m": 0,
        "far": true,
        "mock": true,
        "has_photo": true
      },
      "check_out": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "distance_m": 0,
        "mock": true
      },
      "completed_at": "2026-10-06T05:30:00.000Z",
      "actual_minutes": 0,
      "rating": 0,
      "notes": "string",
      "next_step": "string",
      "objections": [
        "string"
      ],
      "revisit_at": "2026-10-06T05:30:00.000Z",
      "feedback_at": "2026-10-06T05:30:00.000Z",
      "cancelled_reason": "string",
      "no_show_reason": "string",
      "reschedules": [
        {
          "from": "2026-10-06T05:30:00.000Z",
          "to": "2026-10-06T05:30:00.000Z",
          "reason": "string",
          "at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requests": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "at": "2026-10-06T05:30:00.000Z",
          "preferred_at": "2026-10-06T05:30:00.000Z",
          "note": "string",
          "status": "open"
        }
      ],
      "confirm_url": "string",
      "can_edit": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/visits/{id}/photos

Upload URL for a check-in photo

Access: API key with site_visits:write, or a member session. Permission site_visits.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

filenamerequired: string
content_typerequired: string
sizerequired: integer

Response · 200

datarequired: VisitPhotoUpload
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/visits/{id}/photos' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"filename":"string","content_type":"string","size":1}'

Response example

{
  "data": {
    "key": "string",
    "url": "string",
    "method": "PUT",
    "headers": {},
    "expires_at": "2026-10-06T05:30:00.000Z",
    "max_bytes": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/visits/{id}/reschedule

Reschedule a visit

Also rebooks a no-show. Reminders, the client’s confirmation and the OTP start over.

Access: API key with site_visits:write, or a member session. Permission site_visits.edit.

Parameters

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

Request body

scheduled_atrequired: string
reasonrequired: string
duration_min: integer

Response · 200

datarequired: ScheduleVisitResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/visits/{id}/reschedule' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"scheduled_at":"string","reason":"string","duration_min":15}'

Response example

{
  "data": {
    "visit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "scheduled",
      "phase": "upcoming",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string",
        "contact_id": "cmusrceel0000q7kaafxqi1om"
      },
      "agent": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "presales": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_by_id": "cmusrceel0000q7kaafxqi1om",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "ends_at": "2026-10-06T05:30:00.000Z",
      "duration_min": 0,
      "visit_number": 0,
      "meeting_point": "string",
      "pickup": {
        "required": true,
        "address": "string",
        "at": "2026-10-06T05:30:00.000Z"
      },
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "items": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "sort_order": 0,
          "property": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "ref_code": "string",
            "title": "string",
            "listing_type": "string",
            "locality": "string"
          },
          "unit": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "unit_no": "string"
          },
          "planned_at": "2026-10-06T05:30:00.000Z",
          "reaction": "liked",
          "reasons": [
            "string"
          ],
          "remarks": "string"
        }
      ],
      "confirmed": {
        "at": "2026-10-06T05:30:00.000Z",
        "via": "link"
      },
      "otp": {
        "required": true,
        "verified_at": "2026-10-06T05:30:00.000Z",
        "method": "otp",
        "channel": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "expires_at": "2026-10-06T05:30:00.000Z",
        "attempts_left": 0,
        "locked": true,
        "resend_in_sec": 0
      },
      "check_in": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "accuracy_m": 0,
        "distance_m": 0,
        "far": true,
        "mock": true,
        "has_photo": true
      },
      "check_out": {
        "at": "2026-10-06T05:30:00.000Z",
        "lat": 0,
        "lng": 0,
        "distance_m": 0,
        "mock": true
      },
      "completed_at": "2026-10-06T05:30:00.000Z",
      "actual_minutes": 0,
      "rating": 0,
      "notes": "string",
      "next_step": "string",
      "objections": [
        "string"
      ],
      "revisit_at": "2026-10-06T05:30:00.000Z",
      "feedback_at": "2026-10-06T05:30:00.000Z",
      "cancelled_reason": "string",
      "no_show_reason": "string",
      "reschedules": [
        {
          "from": "2026-10-06T05:30:00.000Z",
          "to": "2026-10-06T05:30:00.000Z",
          "reason": "string",
          "at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "requests": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "at": "2026-10-06T05:30:00.000Z",
          "preferred_at": "2026-10-06T05:30:00.000Z",
          "note": "string",
          "status": "open"
        }
      ],
      "confirm_url": "string",
      "can_edit": true,
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    },
    "conflicts": [
      {
        "visit_id": "cmusrceel0000q7kaafxqi1om",
        "kind": "overlap",
        "gap_min": 0,
        "scheduled_at": "2026-10-06T05:30:00.000Z",
        "ends_at": "2026-10-06T05:30:00.000Z",
        "lead_name": "string"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.