Process guard

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

POST/v1/deals/{id}/checklist

Tick a checklist item of the deal’s stage

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

itemrequired: string
donerequired: boolean

Response · 200

datarequired: DealNextSteps
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/deals/{id}/checklist' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"item":"string","done":true}'

Response example

{
  "data": {
    "guard_enabled": true,
    "current": {
      "key": "string",
      "name": "string"
    },
    "checklist": [
      {
        "key": "string",
        "label": "string",
        "required": true,
        "done": true,
        "source": "manual",
        "manual": true
      }
    ],
    "steps": [
      {
        "key": "string",
        "name": "string",
        "category": "string",
        "allowed": true,
        "needs_approval": true,
        "reasons": [
          {
            "code": "string",
            "message": "string"
          }
        ]
      }
    ],
    "can_override": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
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/deals/{id}/next-steps

Valid next stages of a deal

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: DealNextSteps
metarequired: object

Request

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

Response example

{
  "data": {
    "guard_enabled": true,
    "current": {
      "key": "string",
      "name": "string"
    },
    "checklist": [
      {
        "key": "string",
        "label": "string",
        "required": true,
        "done": true,
        "source": "manual",
        "manual": true
      }
    ],
    "steps": [
      {
        "key": "string",
        "name": "string",
        "category": "string",
        "allowed": true,
        "needs_approval": true,
        "reasons": [
          {
            "code": "string",
            "message": "string"
          }
        ]
      }
    ],
    "can_override": true
  },
  "meta": {}
}

Errors

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

POST/v1/leads/{id}/checklist

Tick a checklist item of the lead’s stage

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

itemrequired: string
donerequired: boolean

Response · 200

datarequired: LeadNextSteps
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/leads/{id}/checklist' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"item":"string","done":true}'

Response example

{
  "data": {
    "guard_enabled": true,
    "current": {
      "status_id": "cmusrceel0000q7kaafxqi1om",
      "key": "string",
      "name": "string"
    },
    "checklist": [
      {
        "key": "string",
        "label": "string",
        "required": true,
        "done": true,
        "source": "manual",
        "manual": true
      }
    ],
    "steps": [
      {
        "status_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "string",
        "allowed": true,
        "needs_approval": true,
        "reasons": [
          {
            "code": "string",
            "message": "string"
          }
        ]
      }
    ],
    "can_override": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
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/leads/{id}/next-steps

Valid next statuses of a lead

Every status of the lead’s pipeline with whether it may move there now and why not; the stage checklist.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: LeadNextSteps
metarequired: object

Request

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

Response example

{
  "data": {
    "guard_enabled": true,
    "current": {
      "status_id": "cmusrceel0000q7kaafxqi1om",
      "key": "string",
      "name": "string"
    },
    "checklist": [
      {
        "key": "string",
        "label": "string",
        "required": true,
        "done": true,
        "source": "manual",
        "manual": true
      }
    ],
    "steps": [
      {
        "status_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "string",
        "allowed": true,
        "needs_approval": true,
        "reasons": [
          {
            "code": "string",
            "message": "string"
          }
        ]
      }
    ],
    "can_override": true
  },
  "meta": {}
}

Errors

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

GET/v1/settings/deal-guard

The deal stages’ process guard

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

Response · 200

datarequired: DealGuard
metarequired: object

Request

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

Response example

{
  "data": {
    "enabled": true,
    "sale": {},
    "rent": {},
    "stages": [
      {
        "key": "string",
        "name": "string",
        "category": "string",
        "order": 0
      }
    ],
    "rent_stages": [
      {
        "key": "string",
        "name": "string",
        "category": "string",
        "order": 0
      }
    ],
    "recommended": {
      "sale": {},
      "rent": {}
    }
  },
  "meta": {}
}

Errors

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

PUT/v1/settings/deal-guard

Change the deal stages’ process guard

Rules per deal type (rent covers leases); deal stages never move automatically.

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

Request body

enabledrequired: boolean
salerequired: map of object
rentrequired: map of object

Response · 200

datarequired: DealGuard
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/deal-guard' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"sale":{},"rent":{}}'

Response example

{
  "data": {
    "enabled": true,
    "sale": {},
    "rent": {},
    "stages": [
      {
        "key": "string",
        "name": "string",
        "category": "string",
        "order": 0
      }
    ],
    "rent_stages": [
      {
        "key": "string",
        "name": "string",
        "category": "string",
        "order": 0
      }
    ],
    "recommended": {
      "sale": {},
      "rent": {}
    }
  },
  "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/settings/pipelines/{id}/guard

A pipeline’s process guard

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: PipelineGuard
metarequired: object

Request

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

Response example

{
  "data": {
    "pipeline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "enabled": true,
      "kind": "buyers",
      "kind_label": "string"
    },
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "string",
        "sort_order": 0,
        "is_active": true,
        "rule": {
          "next": [
            "string"
          ],
          "entry": [
            null
          ],
          "checklist": [
            {
              "key": null,
              "label": null,
              "required": null,
              "evidence": null
            }
          ],
          "auto": [
            null
          ]
        },
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "pauses_sla": true
          }
        ]
      }
    ],
    "recommended": {}
  },
  "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.

PUT/v1/settings/pipelines/{id}/guard

Change a pipeline’s process guard

The rules by status key (statuses left out have none), the switch, and the sub-statuses that pause SLAs.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

enabledrequired: boolean
rulesrequired: map of object
pauses_sla: map of boolean

Response · 200

datarequired: PipelineGuard
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/pipelines/{id}/guard' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"rules":{},"pauses_sla":{}}'

Response example

{
  "data": {
    "pipeline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "enabled": true,
      "kind": "buyers",
      "kind_label": "string"
    },
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "string",
        "sort_order": 0,
        "is_active": true,
        "rule": {
          "next": [
            "string"
          ],
          "entry": [
            null
          ],
          "checklist": [
            {
              "key": null,
              "label": null,
              "required": null,
              "evidence": null
            }
          ],
          "auto": [
            null
          ]
        },
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "pauses_sla": true
          }
        ]
      }
    ],
    "recommended": {}
  },
  "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.

{ "data": { "guard_enabled": true, "current": { "key": "string", "name": "string" }, "checklist": [ { "key": "string", "label": "string", "required": true, "done": true, "source": "manual", "manual": true } ], "steps": [ { "key": "string", "name": "string", "category": "string", "allowed": true, "needs_approval": true, "reasons": [ { "code": "string", "message": "string" } ] } ], "can_override": true }, "meta": {} }

{ "data": { "guard_enabled": true, "current": { "status_id": "cmusrceel0000q7kaafxqi1om", "key": "string", "name": "string" }, "checklist": [ { "key": "string", "label": "string", "required": true, "done": true, "source": "manual", "manual": true } ], "steps": [ { "status_id": "cmusrceel0000q7kaafxqi1om", "key": "string", "name": "string", "category": "string", "allowed": true, "needs_approval": true, "reasons": [ { "code": "string", "message": "string" } ] } ], "can_override": true }, "meta": {} }

{ "data": { "enabled": true, "sale": {}, "rent": {}, "stages": [ { "key": "string", "name": "string", "category": "string", "order": 0 } ], "rent_stages": [ { "key": "string", "name": "string", "category": "string", "order": 0 } ], "recommended": { "sale": {}, "rent": {} } }, "meta": {} }

{ "data": { "pipeline": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "enabled": true, "kind": "buyers", "kind_label": "string" }, "statuses": [ { "id": "cmusrceel0000q7kaafxqi1om", "key": "string", "name": "string", "category": "string", "sort_order": 0, "is_active": true, "rule": { "next": [ "string" ], "entry": [ null ], "checklist": [ { "key": null, "label": null, "required": null, "evidence": null } ], "auto": [ null ] }, "sub_statuses": [ { "id": "cmusrceel0000q7kaafxqi1om", "key": "string", "name": "string", "pauses_sla": true } ] } ], "recommended": {} }, "meta": {} }

curl -X PUT 'https://api.propzolo.com/v1/settings/pipelines/{id}/guard' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"enabled":true,"rules":{},"pauses_sla":{}}'