Pipelines

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

GET/v1/pipelines

Pipelines with statuses

Every pipeline with its statuses and sub-statuses in order, switched-off ones included (flagged). Readable with settings.pipelines, settings.view or leads.view; lead counts only for settings access.

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

Response · 200

datarequired: array of PipelineDetail
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "lead_types": [
        "buy"
      ],
      "is_default": true,
      "sort_order": 0,
      "lead_count": 0,
      "statuses": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "pipeline_id": "cmusrceel0000q7kaafxqi1om",
          "key": "string",
          "name": "string",
          "category": "open",
          "color": "string",
          "sort_order": 0,
          "is_default": true,
          "is_active": true,
          "sla_minutes": 0,
          "requirements": {
            "follow_up": "required",
            "site_visit": "required",
            "note": "required",
            "deal": "required",
            "fields": [
              null
            ]
          },
          "lead_count": 0,
          "sub_statuses": [
            {
              "id": null,
              "status_id": null,
              "key": null,
              "name": null,
              "sort_order": null,
              "is_active": null,
              "requirements": null,
              "auto_follow_up_minutes": null,
              "counts_as_contact": null,
              "lead_count": null
            }
          ]
        }
      ]
    }
  ],
  "meta": {}
}

Errors

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

POST/v1/pipelines

Create a pipeline

Starts with a copy of another pipeline’s statuses, or a starter set (New, Follow-up, Won, Lost, Invalid).

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

Request body

namerequired: string
lead_typesrequired: array of LeadType
is_default: boolean
copy_from_id: Id or null
Copy the statuses of this pipeline (else a starter set).

Response · 201

datarequired: PipelineDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/pipelines' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","lead_types":["buy"],"is_default":true,"copy_from_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "lead_types": [
      "buy"
    ],
    "is_default": true,
    "sort_order": 0,
    "lead_count": 0,
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "open",
        "color": "string",
        "sort_order": 0,
        "is_default": true,
        "is_active": true,
        "sla_minutes": 0,
        "requirements": {
          "follow_up": "required",
          "site_visit": "required",
          "note": "required",
          "deal": "required",
          "fields": [
            "string"
          ]
        },
        "lead_count": 0,
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status_id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "sort_order": 0,
            "is_active": true,
            "requirements": {
              "follow_up": null,
              "site_visit": null,
              "note": null,
              "deal": null,
              "fields": null
            },
            "auto_follow_up_minutes": 0,
            "counts_as_contact": true,
            "lead_count": 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.
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/pipelines/reorder

Reorder pipelines

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

Request body

idsrequired: array of Id
Every id once, in the new order.

Response · 200

datarequired: array of PipelineDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/pipelines/reorder' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "lead_types": [
        "buy"
      ],
      "is_default": true,
      "sort_order": 0,
      "lead_count": 0,
      "statuses": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "pipeline_id": "cmusrceel0000q7kaafxqi1om",
          "key": "string",
          "name": "string",
          "category": "open",
          "color": "string",
          "sort_order": 0,
          "is_default": true,
          "is_active": true,
          "sla_minutes": 0,
          "requirements": {
            "follow_up": "required",
            "site_visit": "required",
            "note": "required",
            "deal": "required",
            "fields": [
              null
            ]
          },
          "lead_count": 0,
          "sub_statuses": [
            {
              "id": null,
              "status_id": null,
              "key": null,
              "name": null,
              "sort_order": null,
              "is_active": null,
              "requirements": null,
              "auto_follow_up_minutes": null,
              "counts_as_contact": null,
              "lead_count": null
            }
          ]
        }
      ]
    }
  ],
  "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/pipelines/{id}

A pipeline

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: PipelineDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "lead_types": [
      "buy"
    ],
    "is_default": true,
    "sort_order": 0,
    "lead_count": 0,
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "open",
        "color": "string",
        "sort_order": 0,
        "is_default": true,
        "is_active": true,
        "sla_minutes": 0,
        "requirements": {
          "follow_up": "required",
          "site_visit": "required",
          "note": "required",
          "deal": "required",
          "fields": [
            "string"
          ]
        },
        "lead_count": 0,
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status_id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "sort_order": 0,
            "is_active": true,
            "requirements": {
              "follow_up": null,
              "site_visit": null,
              "note": null,
              "deal": null,
              "fields": null
            },
            "auto_follow_up_minutes": 0,
            "counts_as_contact": true,
            "lead_count": 0
          }
        ]
      }
    ]
  },
  "meta": {}
}

Errors

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

PATCH/v1/pipelines/{id}

Rename a pipeline, change its lead types or make it the default

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
lead_types: array of LeadType
is_default: boolean

Response · 200

datarequired: PipelineDetail
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/pipelines/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","lead_types":["buy"],"is_default":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "lead_types": [
      "buy"
    ],
    "is_default": true,
    "sort_order": 0,
    "lead_count": 0,
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "open",
        "color": "string",
        "sort_order": 0,
        "is_default": true,
        "is_active": true,
        "sla_minutes": 0,
        "requirements": {
          "follow_up": "required",
          "site_visit": "required",
          "note": "required",
          "deal": "required",
          "fields": [
            "string"
          ]
        },
        "lead_count": 0,
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status_id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "sort_order": 0,
            "is_active": true,
            "requirements": {
              "follow_up": null,
              "site_visit": null,
              "note": null,
              "deal": null,
              "fields": null
            },
            "auto_follow_up_minutes": 0,
            "counts_as_contact": true,
            "lead_count": 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.

DELETE/v1/pipelines/{id}

Delete a pipeline

Only a pipeline without leads (deleted leads count) that is not the default (409 otherwise).

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

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

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": true
  },
  "meta": {}
}

Errors

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

POST/v1/pipelines/{id}/statuses

Add a status

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

namerequired: string
key: string or null
Stable key; derived from the name when absent.
categoryrequired: StatusCategory
colorrequired: string
is_default: boolean
is_active: boolean
sla_minutes: integer or null
requirements: object or null
requirements.follow_up: RequirementLevel
requirements.site_visit: RequirementLevel
requirements.note: RequirementLevel
requirements.deal: RequirementLevel
requirements.fields: array of string

Response · 201

datarequired: PipelineDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/pipelines/{id}/statuses' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","key":"string","category":"open","color":"string","is_default":true,"is_active":true,"sla_minutes":1,"requirements":{"follow_up":"required","site_visit":"required","note":"required","deal":"required","fields":["string"]}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "lead_types": [
      "buy"
    ],
    "is_default": true,
    "sort_order": 0,
    "lead_count": 0,
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "open",
        "color": "string",
        "sort_order": 0,
        "is_default": true,
        "is_active": true,
        "sla_minutes": 0,
        "requirements": {
          "follow_up": "required",
          "site_visit": "required",
          "note": "required",
          "deal": "required",
          "fields": [
            "string"
          ]
        },
        "lead_count": 0,
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status_id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "sort_order": 0,
            "is_active": true,
            "requirements": {
              "follow_up": null,
              "site_visit": null,
              "note": null,
              "deal": null,
              "fields": null
            },
            "auto_follow_up_minutes": 0,
            "counts_as_contact": true,
            "lead_count": 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/pipelines/{id}/statuses/reorder

Reorder statuses

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

idsrequired: array of Id
Every id once, in the new order.

Response · 200

datarequired: PipelineDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/pipelines/{id}/statuses/reorder' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "lead_types": [
      "buy"
    ],
    "is_default": true,
    "sort_order": 0,
    "lead_count": 0,
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "open",
        "color": "string",
        "sort_order": 0,
        "is_default": true,
        "is_active": true,
        "sla_minutes": 0,
        "requirements": {
          "follow_up": "required",
          "site_visit": "required",
          "note": "required",
          "deal": "required",
          "fields": [
            "string"
          ]
        },
        "lead_count": 0,
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status_id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "sort_order": 0,
            "is_active": true,
            "requirements": {
              "follow_up": null,
              "site_visit": null,
              "note": null,
              "deal": null,
              "fields": null
            },
            "auto_follow_up_minutes": 0,
            "counts_as_contact": true,
            "lead_count": 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.

PATCH/v1/pipelines/{id}/statuses/{statusId}

Change a status

The key never changes. The default status cannot be switched off.

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

Parameters

idpathrequired: Id
Opaque record id.
statusIdpathrequired: Id
Opaque record id.

Request body

name: string
category: StatusCategory
color: string
is_default: boolean
is_active: boolean
sla_minutes: integer or null
requirements: object or null
requirements.follow_up: RequirementLevel
requirements.site_visit: RequirementLevel
requirements.note: RequirementLevel
requirements.deal: RequirementLevel
requirements.fields: array of string

Response · 200

datarequired: PipelineDetail
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/pipelines/{id}/statuses/{statusId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","category":"open","color":"string","is_default":true,"is_active":true,"sla_minutes":1,"requirements":{"follow_up":"required","site_visit":"required","note":"required","deal":"required","fields":["string"]}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "lead_types": [
      "buy"
    ],
    "is_default": true,
    "sort_order": 0,
    "lead_count": 0,
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "open",
        "color": "string",
        "sort_order": 0,
        "is_default": true,
        "is_active": true,
        "sla_minutes": 0,
        "requirements": {
          "follow_up": "required",
          "site_visit": "required",
          "note": "required",
          "deal": "required",
          "fields": [
            "string"
          ]
        },
        "lead_count": 0,
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status_id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "sort_order": 0,
            "is_active": true,
            "requirements": {
              "follow_up": null,
              "site_visit": null,
              "note": null,
              "deal": null,
              "fields": null
            },
            "auto_follow_up_minutes": 0,
            "counts_as_contact": true,
            "lead_count": 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.

DELETE/v1/pipelines/{id}/statuses/{statusId}

Delete a status

Only a status no lead has had (409 otherwise — switch it off instead).

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

Parameters

idpathrequired: Id
Opaque record id.
statusIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: PipelineDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "lead_types": [
      "buy"
    ],
    "is_default": true,
    "sort_order": 0,
    "lead_count": 0,
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "open",
        "color": "string",
        "sort_order": 0,
        "is_default": true,
        "is_active": true,
        "sla_minutes": 0,
        "requirements": {
          "follow_up": "required",
          "site_visit": "required",
          "note": "required",
          "deal": "required",
          "fields": [
            "string"
          ]
        },
        "lead_count": 0,
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status_id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "sort_order": 0,
            "is_active": true,
            "requirements": {
              "follow_up": null,
              "site_visit": null,
              "note": null,
              "deal": null,
              "fields": null
            },
            "auto_follow_up_minutes": 0,
            "counts_as_contact": true,
            "lead_count": 0
          }
        ]
      }
    ]
  },
  "meta": {}
}

Errors

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

POST/v1/pipelines/{id}/statuses/{statusId}/sub-statuses

Add a sub-status

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

Parameters

idpathrequired: Id
Opaque record id.
statusIdpathrequired: Id
Opaque record id.

Request body

namerequired: string
key: string or null
requirements: object or null
requirements.follow_up: RequirementLevel
requirements.site_visit: RequirementLevel
requirements.note: RequirementLevel
requirements.deal: RequirementLevel
requirements.fields: array of string
auto_follow_up_minutes: integer or null
Automatic retry call after this many minutes (working hours apply), e.g. RNR → 120.
counts_as_contact: boolean
false when no conversation happened (RNR, switched off).
is_active: boolean

Response · 201

datarequired: PipelineDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/pipelines/{id}/statuses/{statusId}/sub-statuses' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","key":"string","requirements":{"follow_up":"required","site_visit":"required","note":"required","deal":"required","fields":["string"]},"auto_follow_up_minutes":1,"counts_as_contact":true,"is_active":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "lead_types": [
      "buy"
    ],
    "is_default": true,
    "sort_order": 0,
    "lead_count": 0,
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "open",
        "color": "string",
        "sort_order": 0,
        "is_default": true,
        "is_active": true,
        "sla_minutes": 0,
        "requirements": {
          "follow_up": "required",
          "site_visit": "required",
          "note": "required",
          "deal": "required",
          "fields": [
            "string"
          ]
        },
        "lead_count": 0,
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status_id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "sort_order": 0,
            "is_active": true,
            "requirements": {
              "follow_up": null,
              "site_visit": null,
              "note": null,
              "deal": null,
              "fields": null
            },
            "auto_follow_up_minutes": 0,
            "counts_as_contact": true,
            "lead_count": 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/pipelines/{id}/statuses/{statusId}/sub-statuses/reorder

Reorder sub-statuses

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

Parameters

idpathrequired: Id
Opaque record id.
statusIdpathrequired: Id
Opaque record id.

Request body

idsrequired: array of Id
Every id once, in the new order.

Response · 200

datarequired: PipelineDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/pipelines/{id}/statuses/{statusId}/sub-statuses/reorder' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "lead_types": [
      "buy"
    ],
    "is_default": true,
    "sort_order": 0,
    "lead_count": 0,
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "open",
        "color": "string",
        "sort_order": 0,
        "is_default": true,
        "is_active": true,
        "sla_minutes": 0,
        "requirements": {
          "follow_up": "required",
          "site_visit": "required",
          "note": "required",
          "deal": "required",
          "fields": [
            "string"
          ]
        },
        "lead_count": 0,
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status_id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "sort_order": 0,
            "is_active": true,
            "requirements": {
              "follow_up": null,
              "site_visit": null,
              "note": null,
              "deal": null,
              "fields": null
            },
            "auto_follow_up_minutes": 0,
            "counts_as_contact": true,
            "lead_count": 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.

PATCH/v1/pipelines/{id}/statuses/{statusId}/sub-statuses/{subId}

Change a sub-status

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

Parameters

idpathrequired: Id
Opaque record id.
statusIdpathrequired: Id
Opaque record id.
subIdpathrequired: Id
Opaque record id.

Request body

name: string
requirements: object or null
requirements.follow_up: RequirementLevel
requirements.site_visit: RequirementLevel
requirements.note: RequirementLevel
requirements.deal: RequirementLevel
requirements.fields: array of string
auto_follow_up_minutes: integer or null
Automatic retry call after this many minutes (working hours apply), e.g. RNR → 120.
counts_as_contact: boolean
false when no conversation happened (RNR, switched off).
is_active: boolean

Response · 200

datarequired: PipelineDetail
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/pipelines/{id}/statuses/{statusId}/sub-statuses/{subId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","requirements":{"follow_up":"required","site_visit":"required","note":"required","deal":"required","fields":["string"]},"auto_follow_up_minutes":1,"counts_as_contact":true,"is_active":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "lead_types": [
      "buy"
    ],
    "is_default": true,
    "sort_order": 0,
    "lead_count": 0,
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "open",
        "color": "string",
        "sort_order": 0,
        "is_default": true,
        "is_active": true,
        "sla_minutes": 0,
        "requirements": {
          "follow_up": "required",
          "site_visit": "required",
          "note": "required",
          "deal": "required",
          "fields": [
            "string"
          ]
        },
        "lead_count": 0,
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status_id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "sort_order": 0,
            "is_active": true,
            "requirements": {
              "follow_up": null,
              "site_visit": null,
              "note": null,
              "deal": null,
              "fields": null
            },
            "auto_follow_up_minutes": 0,
            "counts_as_contact": true,
            "lead_count": 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.

DELETE/v1/pipelines/{id}/statuses/{statusId}/sub-statuses/{subId}

Delete a sub-status

Only a sub-status no lead has had (409 otherwise — switch it off instead).

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

Parameters

idpathrequired: Id
Opaque record id.
statusIdpathrequired: Id
Opaque record id.
subIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: PipelineDetail
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/pipelines/{id}/statuses/{statusId}/sub-statuses/{subId}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "lead_types": [
      "buy"
    ],
    "is_default": true,
    "sort_order": 0,
    "lead_count": 0,
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "open",
        "color": "string",
        "sort_order": 0,
        "is_default": true,
        "is_active": true,
        "sla_minutes": 0,
        "requirements": {
          "follow_up": "required",
          "site_visit": "required",
          "note": "required",
          "deal": "required",
          "fields": [
            "string"
          ]
        },
        "lead_count": 0,
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status_id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "sort_order": 0,
            "is_active": true,
            "requirements": {
              "follow_up": null,
              "site_visit": null,
              "note": null,
              "deal": null,
              "fields": null
            },
            "auto_follow_up_minutes": 0,
            "counts_as_contact": true,
            "lead_count": 0
          }
        ]
      }
    ]
  },
  "meta": {}
}

Errors

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

PATCH/v1/pipelines/{id}/statuses/{statusId}/sub-statuses/{subId}

Change a sub-status

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

Parameters

idpathrequired: Id
Opaque record id.
statusIdpathrequired: Id
Opaque record id.
subIdpathrequired: Id
Opaque record id.

Request body

name: string
requirements: object or null
requirements.follow_up: RequirementLevel
requirements.site_visit: RequirementLevel
requirements.note: RequirementLevel
requirements.deal: RequirementLevel
requirements.fields: array of string
auto_follow_up_minutes: integer or null
Automatic retry call after this many minutes (working hours apply), e.g. RNR → 120.
counts_as_contact: boolean
false when no conversation happened (RNR, switched off).
is_active: boolean

Response · 200

datarequired: PipelineDetail
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/pipelines/{id}/statuses/{statusId}/sub-statuses/{subId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","requirements":{"follow_up":"required","site_visit":"required","note":"required","deal":"required","fields":["string"]},"auto_follow_up_minutes":1,"counts_as_contact":true,"is_active":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "lead_types": [
      "buy"
    ],
    "is_default": true,
    "sort_order": 0,
    "lead_count": 0,
    "statuses": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "pipeline_id": "cmusrceel0000q7kaafxqi1om",
        "key": "string",
        "name": "string",
        "category": "open",
        "color": "string",
        "sort_order": 0,
        "is_default": true,
        "is_active": true,
        "sla_minutes": 0,
        "requirements": {
          "follow_up": "required",
          "site_visit": "required",
          "note": "required",
          "deal": "required",
          "fields": [
            "string"
          ]
        },
        "lead_count": 0,
        "sub_statuses": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "status_id": "cmusrceel0000q7kaafxqi1om",
            "key": "string",
            "name": "string",
            "sort_order": 0,
            "is_active": true,
            "requirements": {
              "follow_up": null,
              "site_visit": null,
              "note": null,
              "deal": null,
              "fields": null
            },
            "auto_follow_up_minutes": 0,
            "counts_as_contact": true,
            "lead_count": 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.