ApprovalRequest

object

idrequired: Id
Opaque record id.
kindrequired: string
workflow (F-02); F-04 adds deal discounts, bookings, stage gates …
statusrequired: "pending" | "on_hold" | "approved" | "edited" | "rejected" | "expired" | …
titlerequired: string
detailsrequired: string or null
textrequired: string or null
What is reviewed (an AI draft …).
edited_textrequired: string or null
The approver’s version ("approve with edits").
allow_editrequired: boolean
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
workflowrequired: object or null
workflow.idrequired: Id
Opaque record id.
workflow.namerequired: string
approversrequired: object
approvers.permissionrequired: string or null
approvers.role_keysrequired: array of string
approvers.member_idsrequired: array of Id
Opaque record id.
due_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
overduerequired: boolean
decided_byrequired: object or null
decided_by.idrequired: Id
Opaque record id.
decided_by.namerequired: string
decided_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
decision_noterequired: string or null
decision_channelrequired: string or null
web · push · whatsapp · link
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
can_deciderequired: boolean
chainrequired: ApprovalChain or null
The chain this request is a level of (F-04).
levelrequired: integer
holdrequired: object or null
hold.reasonrequired: string or null
hold.atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
hold.byrequired: object or null
hold.by.idrequired: Id
Opaque record id.
hold.by.namerequired: string
escalatedrequired: boolean
historyrequired: array of object
history[].atrequired: string
history[].kindrequired: string
history[].by: string or null
history[].note: string or null
history[].channel: string

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "kind": "string",
  "status": "pending",
  "title": "string",
  "details": "string",
  "text": "string",
  "edited_text": "string",
  "allow_edit": true,
  "entity": {
    "type": "string",
    "id": "cmusrceel0000q7kaafxqi1om"
  },
  "lead": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "name": "string"
  },
  "workflow": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "approvers": {
    "permission": "string",
    "role_keys": [
      "string"
    ],
    "member_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ]
  },
  "due_at": "2026-10-06T05:30:00.000Z",
  "overdue": true,
  "decided_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "decided_at": "2026-10-06T05:30:00.000Z",
  "decision_note": "string",
  "decision_channel": "string",
  "created_at": "2026-10-06T05:30:00.000Z",
  "can_decide": true,
  "chain": {
    "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
  },
  "level": 0,
  "hold": {
    "reason": "string",
    "at": "2026-10-06T05:30:00.000Z",
    "by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    }
  },
  "escalated": true,
  "history": [
    {
      "at": "string",
      "kind": "string",
      "by": "string",
      "note": "string",
      "channel": "string"
    }
  ]
}

{ "id": "cmusrceel0000q7kaafxqi1om", "kind": "string", "status": "pending", "title": "string", "details": "string", "text": "string", "edited_text": "string", "allow_edit": true, "entity": { "type": "string", "id": "cmusrceel0000q7kaafxqi1om" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "name": "string" }, "workflow": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "approvers": { "permission": "string", "role_keys": [ "string" ], "member_ids": [ "cmusrceel0000q7kaafxqi1om" ] }, "due_at": "2026-10-06T05:30:00.000Z", "overdue": true, "decided_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "decided_at": "2026-10-06T05:30:00.000Z", "decision_note": "string", "decision_channel": "string", "created_at": "2026-10-06T05:30:00.000Z", "can_decide": true, "chain": { "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 }, "level": 0, "hold": { "reason": "string", "at": "2026-10-06T05:30:00.000Z", "by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } }, "escalated": true, "history": [ { "at": "string", "kind": "string", "by": "string", "note": "string", "channel": "string" } ] }