Help

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

GET/v1/help/articles/{slug}

A help article

The article the help sheet shows in the app; the same text is public at /help/<slug>.

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

Parameters

slugpathrequired: string
Article slug, as in /help/<slug>.

Response · 200

datarequired: HelpArticle
metarequired: object

Request

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

Response example

{
  "data": {
    "slug": "string",
    "title": "string",
    "summary": "string",
    "category": {
      "key": "string",
      "title": "string"
    },
    "version": 0,
    "updated": "2026-10-06",
    "needs": [
      "string"
    ],
    "blocks": [
      {
        "t": "string"
      }
    ],
    "related": [
      {
        "slug": "string",
        "title": "string",
        "summary": "string",
        "category": "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.

GET/v1/help/feedback/{slug}

Your vote on an article

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

Parameters

slugpathrequired: string
Article slug, as in /help/<slug>.

Response · 200

datarequired: HelpFeedback or null
metarequired: object

Request

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

Response example

{
  "data": {
    "article": "string",
    "version": 0,
    "helpful": true,
    "comment": "string",
    "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.

PUT/v1/help/feedback/{slug}

Was this article helpful?

One vote per member and article — voting again changes it. Audited.

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

Parameters

slugpathrequired: string
Article slug, as in /help/<slug>.

Request body

helpfulrequired: boolean
comment: string or null

Response · 200

datarequired: HelpFeedback
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/help/feedback/{slug}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"helpful":true,"comment":"string"}'

Response example

{
  "data": {
    "article": "string",
    "version": 0,
    "helpful": true,
    "comment": "string",
    "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/help/tips

Tips you closed

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

Response · 200

datarequired: HelpTips
metarequired: object

Request

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

Response example

{
  "data": {
    "dismissed": [
      "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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/help/tips

Show tips again

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

Response · 200

datarequired: object
data.resetrequired: integer
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/help/tips' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "reset": 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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/help/tips/{key}

Close a tip

It stays closed on every device.

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

Parameters

keypathrequired: string
Tip key, e.g. leads.list.

Response · 200

datarequired: HelpTips
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/help/tips/{key}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "dismissed": [
      "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.

{ "data": { "slug": "string", "title": "string", "summary": "string", "category": { "key": "string", "title": "string" }, "version": 0, "updated": "2026-10-06", "needs": [ "string" ], "blocks": [ { "t": "string" } ], "related": [ { "slug": "string", "title": "string", "summary": "string", "category": "string" } ] }, "meta": {} }

PUT/v1/help/feedback/{slug}

Was this article helpful?

One vote per member and article — voting again changes it. Audited.

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

Parameters

slugpathrequired: string
Article slug, as in /help/<slug>.

Request body

helpfulrequired: boolean
comment: string or null

Response · 200

datarequired: HelpFeedback
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/help/feedback/{slug}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"helpful":true,"comment":"string"}'

Response example

{
  "data": {
    "article": "string",
    "version": 0,
    "helpful": true,
    "comment": "string",
    "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.