Scheduled reports

Daily, weekly or monthly delivery of a report by email (table + CSV) and WhatsApp (summary), the delivery log, outside recipients with step-up and one-click unsubscribe, and the daily owner digest as a schedulable preset.

GET/v1/reports/custom/{id}/schedules

Schedules of a report

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of ReportSchedule
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "report_id": "cmusrceel0000q7kaafxqi1om",
      "frequency": "daily",
      "time": "string",
      "weekday": 0,
      "month_day": 0,
      "period": "report",
      "channels": [
        "email"
      ],
      "members": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      ],
      "external_emails": [
        {
          "email": "string",
          "unsubscribed": true
        }
      ],
      "status": "active",
      "description": "string",
      "next_run_at": "2026-10-06T05:30:00.000Z",
      "last_run_at": "2026-10-06T05:30:00.000Z",
      "last_status": "string",
      "failure_count": 0,
      "created_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "editable": true,
      "created_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.

POST/v1/reports/custom/{id}/schedules

Schedule a report

Members get it within their own scope. Outside addresses are added separately (step-up).

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

frequencyrequired: "daily" | "weekly" | "monthly"
timerequired: string
weekday: integer or null
month_day: integer or null
period: "report" | "yesterday" | "last_7_days" | "last_week" | "last_month" | "last_30_days"
channelsrequired: array of "email" | "whatsapp"
member_ids: array of Id
Opaque record id.

Response · 201

datarequired: ReportSchedule
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/reports/custom/{id}/schedules' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"frequency":"daily","time":"string","weekday":1,"month_day":0,"period":"report","channels":["email"],"member_ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "report_id": "cmusrceel0000q7kaafxqi1om",
    "frequency": "daily",
    "time": "string",
    "weekday": 0,
    "month_day": 0,
    "period": "report",
    "channels": [
      "email"
    ],
    "members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    ],
    "external_emails": [
      {
        "email": "string",
        "unsubscribed": true
      }
    ],
    "status": "active",
    "description": "string",
    "next_run_at": "2026-10-06T05:30:00.000Z",
    "last_run_at": "2026-10-06T05:30:00.000Z",
    "last_status": "string",
    "failure_count": 0,
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "editable": true,
    "created_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/reports/delivery-settings

Scheduled report delivery settings

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

Response · 200

datarequired: ReportDeliverySettings
metarequired: object

Request

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

Response example

{
  "data": {
    "external_recipients": 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/reports/delivery-settings

Allow or stop reports to outside addresses

The owner’s switch for scheduled reports to email addresses outside the company. Needs a fresh step-up.

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

Request body

external_recipientsrequired: boolean

Response · 200

datarequired: ReportDeliverySettings
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/reports/delivery-settings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"external_recipients":true}'

Response example

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

PATCH/v1/reports/schedules/{id}

Change, pause or resume a schedule

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

frequency: "daily" | "weekly" | "monthly"
time: string
weekday: integer or null
month_day: integer or null
period: "report" | "yesterday" | "last_7_days" | "last_week" | "last_month" | "last_30_days"
channels: array of "email" | "whatsapp"
member_ids: array of Id
Opaque record id.
status: "active" | "paused"

Response · 200

datarequired: ReportSchedule
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/reports/schedules/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"frequency":"daily","time":"string","weekday":1,"month_day":0,"period":"report","channels":["email"],"member_ids":["cmusrceel0000q7kaafxqi1om"],"status":"active"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "report_id": "cmusrceel0000q7kaafxqi1om",
    "frequency": "daily",
    "time": "string",
    "weekday": 0,
    "month_day": 0,
    "period": "report",
    "channels": [
      "email"
    ],
    "members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    ],
    "external_emails": [
      {
        "email": "string",
        "unsubscribed": true
      }
    ],
    "status": "active",
    "description": "string",
    "next_run_at": "2026-10-06T05:30:00.000Z",
    "last_run_at": "2026-10-06T05:30:00.000Z",
    "last_status": "string",
    "failure_count": 0,
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "editable": true,
    "created_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.

DELETE/v1/reports/schedules/{id}

Delete a schedule

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

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

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om"
  },
  "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/reports/schedules/{id}/deliveries

Delivery log of a schedule

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

Parameters

idpathrequired: Id
Opaque record id.
beforequery: Id
Opaque record id.

Response · 200

datarequired: object
data.itemsrequired: array of ReportDelivery
data.nextrequired: Id or null
Opaque record id.
metarequired: object

Request

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

Response example

{
  "data": {
    "items": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "slot": "string",
        "channel": "string",
        "recipient": {
          "type": "member",
          "name": "string"
        },
        "status": "string",
        "attempts": 0,
        "rows": 0,
        "period_label": "string",
        "error": "string",
        "sent_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "next": "cmusrceel0000q7kaafxqi1om"
  },
  "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/reports/schedules/{id}/external-recipients

Outside email recipients of a schedule

Data leaves the company: needs the company’s switch, `reports.export` and a fresh step-up. Outside recipients get the report by email within the schedule owner’s scope, with an unsubscribe link; unsubscribed addresses are refused.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

emailsrequired: array of string

Response · 200

datarequired: ReportSchedule
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/reports/schedules/{id}/external-recipients' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"emails":["string"]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "report_id": "cmusrceel0000q7kaafxqi1om",
    "frequency": "daily",
    "time": "string",
    "weekday": 0,
    "month_day": 0,
    "period": "report",
    "channels": [
      "email"
    ],
    "members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    ],
    "external_emails": [
      {
        "email": "string",
        "unsubscribed": true
      }
    ],
    "status": "active",
    "description": "string",
    "next_run_at": "2026-10-06T05:30:00.000Z",
    "last_run_at": "2026-10-06T05:30:00.000Z",
    "last_status": "string",
    "failure_count": 0,
    "created_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "editable": true,
    "created_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/reports/schedules/{id}/send

Send a scheduled report now

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 202

datarequired: object
data.queuedrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/reports/schedules/{id}/send' \
  -H 'Authorization: Bearer pz_live_…'

Response example

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

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "report_id": "cmusrceel0000q7kaafxqi1om", "frequency": "daily", "time": "string", "weekday": 0, "month_day": 0, "period": "report", "channels": [ "email" ], "members": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } ], "external_emails": [ { "email": "string", "unsubscribed": true } ], "status": "active", "description": "string", "next_run_at": "2026-10-06T05:30:00.000Z", "last_run_at": "2026-10-06T05:30:00.000Z", "last_status": "string", "failure_count": 0, "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "editable": true, "created_at": "2026-10-06T05:30:00.000Z" } ], "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/reports/custom/{id}/schedules' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"frequency":"daily","time":"string","weekday":1,"month_day":0,"period":"report","channels":["email"],"member_ids":["cmusrceel0000q7kaafxqi1om"]}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "report_id": "cmusrceel0000q7kaafxqi1om", "frequency": "daily", "time": "string", "weekday": 0, "month_day": 0, "period": "report", "channels": [ "email" ], "members": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } ], "external_emails": [ { "email": "string", "unsubscribed": true } ], "status": "active", "description": "string", "next_run_at": "2026-10-06T05:30:00.000Z", "last_run_at": "2026-10-06T05:30:00.000Z", "last_status": "string", "failure_count": 0, "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "editable": true, "created_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

PATCH/v1/reports/delivery-settings

Allow or stop reports to outside addresses

The owner’s switch for scheduled reports to email addresses outside the company. Needs a fresh step-up.

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

Request body

external_recipientsrequired: boolean

Response · 200

datarequired: ReportDeliverySettings
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/reports/delivery-settings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"external_recipients":true}'

Response example

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

curl -X PATCH 'https://api.propzolo.com/v1/reports/schedules/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"frequency":"daily","time":"string","weekday":1,"month_day":0,"period":"report","channels":["email"],"member_ids":["cmusrceel0000q7kaafxqi1om"],"status":"active"}'

{ "data": { "items": [ { "id": "cmusrceel0000q7kaafxqi1om", "slot": "string", "channel": "string", "recipient": { "type": "member", "name": "string" }, "status": "string", "attempts": 0, "rows": 0, "period_label": "string", "error": "string", "sent_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z" } ], "next": "cmusrceel0000q7kaafxqi1om" }, "meta": {} }