Assignment

Lead routing: rules and their simulator, routing profiles, the assignment log, pools, SLA, staff exit.

GET/v1/assignment-logs

The assignment log

Newest first, within your lead scope. `via` takes a comma list.

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

Parameters

member_idquery: Id
Opaque record id.
rule_idquery: Id
Opaque record id.
lead_idquery: Id
Opaque record id.
viaquery: string
fromquery: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
toquery: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of AssignmentLogEntry
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "created_at": "2026-10-06T05:30:00.000Z",
      "via": "string",
      "reason": "string",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "from": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "to": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "rule": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "actor": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    }
  ],
  "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.

GET/v1/assignment-rules

Assignment rules in evaluation order

The first active rule whose conditions match a lead decides; a source can route to its own rule.

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

Response · 200

datarequired: array of AssignmentRule
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "position": 0,
      "priority": 0,
      "is_active": true,
      "method": "round_robin",
      "conditions": {
        "filter": null,
        "match": {
          "language": "off",
          "locality": "off",
          "specialization": "off"
        },
        "hourly_cap": 0
      },
      "summary": "string",
      "only_available": true,
      "active_app_minutes": 0,
      "outside_shift": "assign",
      "daily_cap": 0,
      "max_untouched": 0,
      "rotation_enabled": true,
      "rotation_minutes": 0,
      "rotation_max": 0,
      "rotation_final": "pool",
      "rotation_scope": "auto",
      "second_chance_enabled": true,
      "second_chance_hours": 0,
      "second_chance_attempts": 0,
      "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
      "members": [
        {
          "member_id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "enabled": true,
          "weight": 0,
          "daily_cap": 0
        }
      ],
      "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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/assignment-rules

Create an assignment rule

Added last in the order. Conditions use the assignment condition fields; members must be active.

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

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

namerequired: string
is_active: boolean
method: AssignmentMethod
conditions: object
conditions.filter: FilterNode or null
PropZolo filter: { all: [...] } | { any: [...] } | { not: … } | { field, op, value }
conditions.match: object
conditions.match.language: CandidateMatchMode
require: skip members who do not fit · prefer: fitting members first, then everyone · off.
conditions.match.locality: CandidateMatchMode
require: skip members who do not fit · prefer: fitting members first, then everyone · off.
conditions.match.specialization: CandidateMatchMode
require: skip members who do not fit · prefer: fitting members first, then everyone · off.
conditions.hourly_cap: integer or null
only_available: boolean
active_app_minutes: integer or null
outside_shift: "assign" | "hold"
daily_cap: integer or null
max_untouched: integer or null
rotation_enabled: boolean
rotation_minutes: integer
rotation_max: integer
rotation_final: "pool" | "keep"
rotation_scope: "auto" | "all" | "off"
second_chance_enabled: boolean
second_chance_hours: integer
second_chance_attempts: integer
fallback_member_id: Id or null
Opaque record id.
members: array of object
members[].member_idrequired: Id
Opaque record id.
members[].enabled: boolean
members[].weight: integer
members[].daily_cap: integer or null

Response · 201

datarequired: AssignmentRule
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/assignment-rules' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","is_active":true,"method":"round_robin","conditions":{"filter":null,"match":{"language":"off","locality":"off","specialization":"off"},"hourly_cap":1},"only_available":true,"active_app_minutes":1,"outside_shift":"assign","daily_cap":1,"max_untouched":1,"rotation_enabled":true,"rotation_minutes":1,"rotation_max":0,"rotation_final":"pool","rotation_scope":"auto","second_chance_enabled":true,"second_chance_hours":1,"second_chance_attempts":1,"fallback_member_id":"cmusrceel0000q7kaafxqi1om","members":[{"member_id":"cmusrceel0000q7kaafxqi1om","enabled":true,"weight":0,"daily_cap":1}]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "position": 0,
    "priority": 0,
    "is_active": true,
    "method": "round_robin",
    "conditions": {
      "filter": null,
      "match": {
        "language": "off",
        "locality": "off",
        "specialization": "off"
      },
      "hourly_cap": 0
    },
    "summary": "string",
    "only_available": true,
    "active_app_minutes": 0,
    "outside_shift": "assign",
    "daily_cap": 0,
    "max_untouched": 0,
    "rotation_enabled": true,
    "rotation_minutes": 0,
    "rotation_max": 0,
    "rotation_final": "pool",
    "rotation_scope": "auto",
    "second_chance_enabled": true,
    "second_chance_hours": 0,
    "second_chance_attempts": 0,
    "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
    "members": [
      {
        "member_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "enabled": true,
        "weight": 0,
        "daily_cap": 0
      }
    ],
    "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.
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/assignment-rules/members

Members with their routing profile and today’s load

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

Response · 200

datarequired: array of RoutingMember
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "role": "string",
      "branch_id": "cmusrceel0000q7kaafxqi1om",
      "active": true,
      "shift": {
        "days": [
          1
        ],
        "start": "string",
        "end": "string"
      },
      "lead_capacity": 0,
      "languages": [
        "string"
      ],
      "service_locality_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "specializations": [
        "string"
      ],
      "today": 0,
      "open_leads": 0,
      "untouched": 0,
      "app_seen_at": "2026-10-06T05:30:00.000Z",
      "on_leave": true,
      "rules": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/assignment-rules/members/{id}

Change a member’s routing profile

Shift (null = the company hours), open-lead capacity, languages, service localities, specialisations.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

shift: MemberShiftInput or null
ISO weekdays (1 = Monday); end ≤ start runs past midnight.
lead_capacity: integer or null
languages: array of string
service_locality_ids: array of Id
Opaque record id.
specializations: array of "resale" | "rentals" | "projects" | "commercial" | "plots"

Response · 200

datarequired: RoutingMember
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/assignment-rules/members/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"shift":{"days":[1],"start":"string","end":"string"},"lead_capacity":1,"languages":["string"],"service_locality_ids":["cmusrceel0000q7kaafxqi1om"],"specializations":["resale"]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "role": "string",
    "branch_id": "cmusrceel0000q7kaafxqi1om",
    "active": true,
    "shift": {
      "days": [
        1
      ],
      "start": "string",
      "end": "string"
    },
    "lead_capacity": 0,
    "languages": [
      "string"
    ],
    "service_locality_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "specializations": [
      "string"
    ],
    "today": 0,
    "open_leads": 0,
    "untouched": 0,
    "app_seen_at": "2026-10-06T05:30:00.000Z",
    "on_leave": true,
    "rules": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "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.

GET/v1/assignment-rules/options

What the rule editor offers

Condition fields with tenant values (sources, projects, branches, teams), methods and members.

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

Response · 200

datarequired: AssignmentOptions
metarequired: object

Request

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

Response example

{
  "data": {
    "fields": [
      {
        "key": "string",
        "label": "string",
        "type": "string",
        "options": [
          {
            "value": null,
            "label": "string"
          }
        ],
        "of": "string",
        "money": true,
        "group": "string",
        "nullable": true
      }
    ],
    "methods": [
      {
        "value": "round_robin",
        "label": "string"
      }
    ],
    "sources": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "assignment_rule_id": "cmusrceel0000q7kaafxqi1om"
      }
    ],
    "members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "active": true
      }
    ],
    "localities": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "city": "string"
      }
    ],
    "languages": [
      {
        "value": null,
        "label": "string"
      }
    ],
    "specializations": [
      {
        "value": null,
        "label": "string"
      }
    ],
    "timezone": "string",
    "can_edit": 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.

POST/v1/assignment-rules/reorder

Change the order of the rules

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

Request body

idsrequired: array of Id
Every rule once, first = first.

Response · 200

datarequired: array of AssignmentRule
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "position": 0,
      "priority": 0,
      "is_active": true,
      "method": "round_robin",
      "conditions": {
        "filter": null,
        "match": {
          "language": "off",
          "locality": "off",
          "specialization": "off"
        },
        "hourly_cap": 0
      },
      "summary": "string",
      "only_available": true,
      "active_app_minutes": 0,
      "outside_shift": "assign",
      "daily_cap": 0,
      "max_untouched": 0,
      "rotation_enabled": true,
      "rotation_minutes": 0,
      "rotation_max": 0,
      "rotation_final": "pool",
      "rotation_scope": "auto",
      "second_chance_enabled": true,
      "second_chance_hours": 0,
      "second_chance_attempts": 0,
      "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
      "members": [
        {
          "member_id": "cmusrceel0000q7kaafxqi1om",
          "name": "string",
          "enabled": true,
          "weight": 0,
          "daily_cap": 0
        }
      ],
      "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.
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/assignment-rules/settings

Company-wide routing settings

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

Response · 200

datarequired: RoutingSettings
metarequired: object

Request

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

Response example

{
  "data": {
    "phone_stale_minutes": 1,
    "require_check_in": true,
    "rotation_warning_minutes": 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/assignment-rules/settings

Change the routing settings

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

Request body

phone_stale_minutes: integer
An owner whose phone has not synced for this long gets twice the rotation time.
require_check_in: boolean
Only members punched in today receive automatic leads.
rotation_warning_minutes: integer
Warn the owner this many shift minutes before a lead rotates (0 = off).

Response · 200

datarequired: RoutingSettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/assignment-rules/settings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"phone_stale_minutes":1,"require_check_in":true,"rotation_warning_minutes":0}'

Response example

{
  "data": {
    "phone_stale_minutes": 1,
    "require_check_in": true,
    "rotation_warning_minutes": 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/assignment-rules/simulate

Who would get this lead?

Evaluates the rules for an existing or described lead and explains every step. Writes nothing.

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

Request body

lead_id: Id or null
Opaque record id.
lead: DescribedLead or null
at: DateTime or null
Simulate at another moment (default: now).

Response · 200

datarequired: AssignmentSimulation
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/assignment-rules/simulate' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_id":"cmusrceel0000q7kaafxqi1om","lead":{"lead_type":"buy","source_id":"cmusrceel0000q7kaafxqi1om","campaign_id":"cmusrceel0000q7kaafxqi1om","sub_source":"string","channel":"string","project_id":"cmusrceel0000q7kaafxqi1om","property_id":"cmusrceel0000q7kaafxqi1om","branch_id":"cmusrceel0000q7kaafxqi1om","team_id":"cmusrceel0000q7kaafxqi1om","temperature":"hot","budget_min":0,"budget_max":0,"bhk":[0],"property_types":["string"],"locality_ids":["cmusrceel0000q7kaafxqi1om"],"category":"string","city":"string","language":"string","is_nri":true,"tags":["string"]},"at":"2026-10-06T05:30:00.000Z"}'

Response example

{
  "data": {
    "at": "2026-10-06T05:30:00.000Z",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "rules": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "position": 0,
        "is_active": true,
        "result": "matched",
        "via_source": true,
        "conditions": [
          {
            "text": "string",
            "passed": true
          }
        ]
      }
    ],
    "rule": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "method": "string",
      "via_source": true
    },
    "candidates": [
      {
        "member_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "eligible": true,
        "winner": true,
        "reason": "excluded",
        "reason_label": "string",
        "weight": 0,
        "today": 0,
        "daily_cap": 0,
        "last_hour": 0,
        "untouched": 0,
        "open_leads": 0,
        "lead_capacity": 0,
        "on_shift": true,
        "shift": "string",
        "app_seen_at": "2026-10-06T05:30:00.000Z",
        "fits": {
          "language": true,
          "locality": true,
          "specialization": true
        }
      }
    ],
    "outcome": {
      "kind": "assign",
      "member_id": "cmusrceel0000q7kaafxqi1om",
      "member_name": "string",
      "method": "string",
      "text": "string",
      "until": "2026-10-06T05:30:00.000Z"
    },
    "relaxed": 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/assignment-rules/staff-exit/{memberId}

What a leaving member still holds

Open leads, pre-sales slots, tasks, upcoming visits and open deals, with the hand-over progress.

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

Parameters

memberIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: StaffExitSummary
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/assignment-rules/staff-exit/{memberId}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "member": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "active": true,
      "reports_to_id": "cmusrceel0000q7kaafxqi1om"
    },
    "counts": {
      "leads": 0,
      "presales_leads": 0,
      "tasks": 0,
      "visits": 0,
      "deals": 0
    },
    "state": {
      "member_id": "cmusrceel0000q7kaafxqi1om",
      "status": "queued",
      "target": {
        "kind": "member",
        "member_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "team_id": "cmusrceel0000q7kaafxqi1om"
      },
      "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
      "totals": {
        "leads": 0,
        "presales_leads": 0,
        "tasks": 0,
        "visits": 0,
        "deals": 0
      },
      "moved": {
        "leads": 0,
        "presales_leads": 0,
        "tasks": 0,
        "visits": 0,
        "deals": 0
      },
      "recipients": {},
      "turn": 0,
      "started_at": "2026-10-06T05:30:00.000Z",
      "started_by": "cmusrceel0000q7kaafxqi1om",
      "finished_at": "2026-10-06T05:30:00.000Z",
      "error": "string"
    },
    "suggestions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "same_team": true,
        "open_leads": 0
      }
    ],
    "teams": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "members": 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/assignment-rules/staff-exit/{memberId}

Hand over a leaving member’s work

Runs in the background in batches; poll the summary for progress. Needs `settings.users` or routing.

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

Parameters

memberIdpathrequired: 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

targetrequired: StaffExitTarget
fallback_member_id: Id or null
Opaque record id.

Response · 202

datarequired: StaffExitState
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/assignment-rules/staff-exit/{memberId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"target":{"kind":"member","member_id":"cmusrceel0000q7kaafxqi1om","member_ids":["cmusrceel0000q7kaafxqi1om"],"team_id":"cmusrceel0000q7kaafxqi1om"},"fallback_member_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "member_id": "cmusrceel0000q7kaafxqi1om",
    "status": "queued",
    "target": {
      "kind": "member",
      "member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "team_id": "cmusrceel0000q7kaafxqi1om"
    },
    "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
    "totals": {
      "leads": 0,
      "presales_leads": 0,
      "tasks": 0,
      "visits": 0,
      "deals": 0
    },
    "moved": {
      "leads": 0,
      "presales_leads": 0,
      "tasks": 0,
      "visits": 0,
      "deals": 0
    },
    "recipients": {},
    "turn": 0,
    "started_at": "2026-10-06T05:30:00.000Z",
    "started_by": "cmusrceel0000q7kaafxqi1om",
    "finished_at": "2026-10-06T05:30:00.000Z",
    "error": "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/assignment-rules/staff-exit/{memberId}/preview

Preview a hand-over

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

Parameters

memberIdpathrequired: Id
Opaque record id.

Request body

targetrequired: StaffExitTarget
fallback_member_id: Id or null
Opaque record id.

Response · 200

datarequired: object
data.countsrequired: object
data.counts.leadsrequired: integer
data.counts.presales_leadsrequired: integer
data.counts.tasksrequired: integer
data.counts.visitsrequired: integer
data.counts.dealsrequired: integer
data.planrequired: array of object
data.plan[].member_idrequired: Id
Opaque record id.
data.plan[].namerequired: string
data.plan[].leadsrequired: integer
data.to_poolrequired: integer
data.fallbackrequired: object or null
data.fallback.member_idrequired: Id
Opaque record id.
data.fallback.namerequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/assignment-rules/staff-exit/{memberId}/preview' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"target":{"kind":"member","member_id":"cmusrceel0000q7kaafxqi1om","member_ids":["cmusrceel0000q7kaafxqi1om"],"team_id":"cmusrceel0000q7kaafxqi1om"},"fallback_member_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "counts": {
      "leads": 0,
      "presales_leads": 0,
      "tasks": 0,
      "visits": 0,
      "deals": 0
    },
    "plan": [
      {
        "member_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "leads": 0
      }
    ],
    "to_pool": 0,
    "fallback": {
      "member_id": "cmusrceel0000q7kaafxqi1om",
      "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.

GET/v1/assignment-rules/{id}

An assignment rule

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: AssignmentRule
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "position": 0,
    "priority": 0,
    "is_active": true,
    "method": "round_robin",
    "conditions": {
      "filter": null,
      "match": {
        "language": "off",
        "locality": "off",
        "specialization": "off"
      },
      "hourly_cap": 0
    },
    "summary": "string",
    "only_available": true,
    "active_app_minutes": 0,
    "outside_shift": "assign",
    "daily_cap": 0,
    "max_untouched": 0,
    "rotation_enabled": true,
    "rotation_minutes": 0,
    "rotation_max": 0,
    "rotation_final": "pool",
    "rotation_scope": "auto",
    "second_chance_enabled": true,
    "second_chance_hours": 0,
    "second_chance_attempts": 0,
    "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
    "members": [
      {
        "member_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "enabled": true,
        "weight": 0,
        "daily_cap": 0
      }
    ],
    "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/assignment-rules/{id}

Change an assignment rule

`members`, when sent, replaces the rule’s members. Every change is in the audit log.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

name: string
is_active: boolean
method: AssignmentMethod
conditions: object
conditions.filter: FilterNode or null
PropZolo filter: { all: [...] } | { any: [...] } | { not: … } | { field, op, value }
conditions.match: object
conditions.match.language: CandidateMatchMode
require: skip members who do not fit · prefer: fitting members first, then everyone · off.
conditions.match.locality: CandidateMatchMode
require: skip members who do not fit · prefer: fitting members first, then everyone · off.
conditions.match.specialization: CandidateMatchMode
require: skip members who do not fit · prefer: fitting members first, then everyone · off.
conditions.hourly_cap: integer or null
only_available: boolean
active_app_minutes: integer or null
outside_shift: "assign" | "hold"
daily_cap: integer or null
max_untouched: integer or null
rotation_enabled: boolean
rotation_minutes: integer
rotation_max: integer
rotation_final: "pool" | "keep"
rotation_scope: "auto" | "all" | "off"
second_chance_enabled: boolean
second_chance_hours: integer
second_chance_attempts: integer
fallback_member_id: Id or null
Opaque record id.
members: array of object
members[].member_idrequired: Id
Opaque record id.
members[].enabled: boolean
members[].weight: integer
members[].daily_cap: integer or null

Response · 200

datarequired: AssignmentRule
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/assignment-rules/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","is_active":true,"method":"round_robin","conditions":{"filter":null,"match":{"language":"off","locality":"off","specialization":"off"},"hourly_cap":1},"only_available":true,"active_app_minutes":1,"outside_shift":"assign","daily_cap":1,"max_untouched":1,"rotation_enabled":true,"rotation_minutes":1,"rotation_max":0,"rotation_final":"pool","rotation_scope":"auto","second_chance_enabled":true,"second_chance_hours":1,"second_chance_attempts":1,"fallback_member_id":"cmusrceel0000q7kaafxqi1om","members":[{"member_id":"cmusrceel0000q7kaafxqi1om","enabled":true,"weight":0,"daily_cap":1}]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "position": 0,
    "priority": 0,
    "is_active": true,
    "method": "round_robin",
    "conditions": {
      "filter": null,
      "match": {
        "language": "off",
        "locality": "off",
        "specialization": "off"
      },
      "hourly_cap": 0
    },
    "summary": "string",
    "only_available": true,
    "active_app_minutes": 0,
    "outside_shift": "assign",
    "daily_cap": 0,
    "max_untouched": 0,
    "rotation_enabled": true,
    "rotation_minutes": 0,
    "rotation_max": 0,
    "rotation_final": "pool",
    "rotation_scope": "auto",
    "second_chance_enabled": true,
    "second_chance_hours": 0,
    "second_chance_attempts": 0,
    "fallback_member_id": "cmusrceel0000q7kaafxqi1om",
    "members": [
      {
        "member_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "enabled": true,
        "weight": 0,
        "daily_cap": 0
      }
    ],
    "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.

DELETE/v1/assignment-rules/{id}

Delete an assignment rule

Sources routed to it fall back to the ordered rules; its log rows stay.

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

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/assignment-rules/{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.

GET/v1/pools

Lead pools with their counts

“All unassigned leads” is always first. `mine` shows what you may still claim today.

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

Response · 200

datarequired: array of LeadPool
metarequired: object
meta.can_claimrequired: boolean
meta.can_giverequired: boolean
meta.can_editrequired: boolean
meta.membersrequired: array of object
Active members you may give leads to.
meta.members[].idrequired: Id
Opaque record id.
meta.members[].namerequired: string

Request

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

Response example

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "branch_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "team_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "source_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "claim_daily_limit": 1,
      "max_open_leads": 1,
      "auto_return_hours": 1,
      "low_alert_below": 1,
      "claimer_member_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "count": 0,
      "fresh": 0,
      "mine": {
        "may_claim": true,
        "claimed_today": 0,
        "remaining_today": 0,
        "capacity_left": 0
      }
    }
  ],
  "meta": {
    "can_claim": true,
    "can_give": true,
    "can_edit": true,
    "members": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    ]
  }
}

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/pools

Save the pool definitions

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

Request body

poolsrequired: array of LeadPoolInput

Response · 200

datarequired: array of LeadPoolDefinition
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/pools' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"pools":[{"id":"string","name":"string","branch_ids":["cmusrceel0000q7kaafxqi1om"],"team_ids":["cmusrceel0000q7kaafxqi1om"],"source_ids":["cmusrceel0000q7kaafxqi1om"],"claim_daily_limit":1,"max_open_leads":1,"auto_return_hours":1,"low_alert_below":1,"claimer_member_ids":["cmusrceel0000q7kaafxqi1om"]}]}'

Response example

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "branch_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "team_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "source_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "claim_daily_limit": 1,
      "max_open_leads": 1,
      "auto_return_hours": 1,
      "low_alert_below": 1,
      "claimer_member_ids": [
        "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.
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/pools/{id}/claim

Claim a lead from a pool

A given lead, or the longest-waiting one. 409 when over the daily limit or capacity, or taken first.

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

Parameters

idpathrequired: string
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_id: Id or null
Opaque record id.

Response · 200

datarequired: object
data.lead_idrequired: Id
Opaque record id.
data.claimed_todayrequired: integer
data.remaining_todayrequired: integer or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/pools/{id}/claim' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "lead_id": "cmusrceel0000q7kaafxqi1om",
    "claimed_today": 0,
    "remaining_today": 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/pools/{id}/give

Give members leads from a pool

Each member gets up to `count` random leads (never beyond their open-lead capacity).

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

Parameters

idpathrequired: string
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

member_idsrequired: array of Id
Opaque record id.
countrequired: integer
fresh_only: boolean

Response · 200

datarequired: object
data.givenrequired: array of object
data.given[].member_idrequired: Id
Opaque record id.
data.given[].countrequired: integer
data.totalrequired: integer
data.shortrequired: boolean
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/pools/{id}/give' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"member_ids":["cmusrceel0000q7kaafxqi1om"],"count":1,"fresh_only":true}'

Response example

{
  "data": {
    "given": [
      {
        "member_id": "cmusrceel0000q7kaafxqi1om",
        "count": 0
      }
    ],
    "total": 0,
    "short": 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/pools/{id}/leads

Leads waiting in a pool

Longest waiting first. Phone numbers are never included.

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

Parameters

idpathrequired: string
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of LeadPoolLead
metarequired: PageMeta

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string",
      "lead_type": "string",
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "budget_min": 0,
      "budget_max": 0,
      "bhk": [
        0
      ],
      "locality_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "city": "string",
      "call_attempts": 0,
      "enquiry_count": 0,
      "received_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "waiting": {
        "via": "string",
        "reason": "string",
        "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.
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/sla/digest

A day of first responses

Leads that arrived that company day: on time, late, breached, per owner, plus uncalled open leads.

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

Parameters

dayquery: LocalDate
Calendar date YYYY-MM-DD in the company time zone.

Response · 200

datarequired: SlaDigest
metarequired: object

Request

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

Response example

{
  "data": {
    "day": "2026-10-06",
    "totals": {
      "leads": 0,
      "met": 0,
      "met_late": 0,
      "breached": 0,
      "pending": 0,
      "untouched": 0
    },
    "avg_response_minutes": 0,
    "members": [
      {
        "member_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "leads": 0,
        "met": 0,
        "met_late": 0,
        "breached": 0,
        "untouched": 0,
        "avg_response_minutes": 0
      }
    ],
    "breaches": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string",
        "owner": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "source": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "created_at": "2026-10-06T05:30:00.000Z",
        "due_at": "2026-10-06T05:30:00.000Z",
        "state": "none",
        "minutes": 0,
        "elapsed_minutes": 0,
        "remaining_minutes": 0,
        "overdue_minutes": 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.
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/sla/leads

Unanswered leads against their SLA

At risk and breached by default (`state=open` adds on-track ones), most urgent first.

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

Parameters

statequery: "at_risk" | "breached" | "open"
limitquery: integer

Response · 200

datarequired: array of SlaLead
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string",
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "source": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "due_at": "2026-10-06T05:30:00.000Z",
      "state": "none",
      "minutes": 0,
      "elapsed_minutes": 0,
      "remaining_minutes": 0,
      "overdue_minutes": 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.
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/sla/settings

First-response SLA settings

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

Response · 200

datarequired: FirstResponseSlaSettings
metarequired: object

Request

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

Response example

{
  "data": {
    "enabled": true,
    "default_minutes": 1,
    "per_source": {},
    "at_risk_percent": 10,
    "clock": "business",
    "notify_manager": true,
    "digest_enabled": true,
    "digest_time": "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.

PUT/v1/sla/settings

Change the first-response SLA

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

Request body

enabled: boolean
default_minutes: integer or null
per_source: map of integer or null
at_risk_percent: integer
clock: "business" | "calendar"
notify_manager: boolean
digest_enabled: boolean
digest_time: string

Response · 200

datarequired: FirstResponseSlaSettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/sla/settings' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"default_minutes":1,"per_source":{},"at_risk_percent":10,"clock":"business","notify_manager":true,"digest_enabled":true,"digest_time":"string"}'

Response example

{
  "data": {
    "enabled": true,
    "default_minutes": 1,
    "per_source": {},
    "at_risk_percent": 10,
    "clock": "business",
    "notify_manager": true,
    "digest_enabled": true,
    "digest_time": "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.