ApprovalChain

object

idrequired: Id
Opaque record id.
kindrequired: string
The policy: export, lead_delete, deal_delete, deal_discount, rent_floor, …
kind_labelrequired: string
statusrequired: "pending" | "approved" | "rejected" | "expired" | "cancelled"
titlerequired: string
reasonrequired: string or null
Why approval is needed.
summaryrequired: array of object
summary[].labelrequired: string
summary[].valuerequired: string
levelrequired: integer
The level deciding now (or the last one).
levelsrequired: array of object
levels[].levelrequired: integer
levels[].namerequired: string or null
levels[].statusrequired: string
A request status, or `waiting` (not reached yet) / `skipped`.
levels[].decided_byrequired: object or null
levels[].decided_by.idrequired: Id
Opaque record id.
levels[].decided_by.namerequired: string
levels[].decided_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
levels[].decision_noterequired: string or null
levels[].channelrequired: string or null
levels[].hold_reasonrequired: string or null
levels[].escalatedrequired: boolean
levels[].due_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
requested_byrequired: object or null
requested_by.idrequired: Id
Opaque record id.
requested_by.namerequired: string
request_noterequired: string or null
action_statusrequired: "waiting" | "applying" | "applied" | "failed" | "dropped"
What became of the action: applied once approved, dropped on rejection or expiry.
action_errorrequired: string or null
applied_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
entityrequired: object or null
entity.typerequired: string
entity.idrequired: Id
Opaque record id.
leadrequired: object or null
lead.idrequired: Id
Opaque record id.
lead.refrequired: string
lead.namerequired: string or null
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
decided_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
can_cancelrequired: boolean

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "kind": "string",
  "kind_label": "string",
  "status": "pending",
  "title": "string",
  "reason": "string",
  "summary": [
    {
      "label": "string",
      "value": "string"
    }
  ],
  "level": 0,
  "levels": [
    {
      "level": 0,
      "name": "string",
      "status": "string",
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "channel": "string",
      "hold_reason": "string",
      "escalated": true,
      "due_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "requested_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "request_note": "string",
  "action_status": "waiting",
  "action_error": "string",
  "applied_at": "2026-10-06T05:30:00.000Z",
  "entity": {
    "type": "string",
    "id": "cmusrceel0000q7kaafxqi1om"
  },
  "lead": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "name": "string"
  },
  "created_at": "2026-10-06T05:30:00.000Z",
  "decided_at": "2026-10-06T05:30:00.000Z",
  "can_cancel": true
}

{ "id": "cmusrceel0000q7kaafxqi1om", "kind": "string", "kind_label": "string", "status": "pending", "title": "string", "reason": "string", "summary": [ { "label": "string", "value": "string" } ], "level": 0, "levels": [ { "level": 0, "name": "string", "status": "string", "decided_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "decided_at": "2026-10-06T05:30:00.000Z", "decision_note": "string", "channel": "string", "hold_reason": "string", "escalated": true, "due_at": "2026-10-06T05:30:00.000Z" } ], "requested_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "request_note": "string", "action_status": "waiting", "action_error": "string", "applied_at": "2026-10-06T05:30:00.000Z", "entity": { "type": "string", "id": "cmusrceel0000q7kaafxqi1om" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "decided_at": "2026-10-06T05:30:00.000Z", "can_cancel": true }