LeadNextSteps

object

guard_enabledrequired: boolean
currentrequired: object
current.status_idrequired: Id
Opaque record id.
current.keyrequired: string
current.namerequired: string
checklistrequired: array of object
checklist[].keyrequired: string
checklist[].labelrequired: string
checklist[].requiredrequired: boolean
checklist[].donerequired: boolean
checklist[].sourcerequired: "manual" | "evidence" or null
checklist[].manualrequired: boolean
Ticked by hand (items with evidence tick themselves).
stepsrequired: array of object
steps[].status_idrequired: Id
Opaque record id.
steps[].keyrequired: string
steps[].namerequired: string
steps[].categoryrequired: string
steps[].allowedrequired: boolean
steps[].needs_approvalrequired: boolean
Only an approval is missing: the move can be asked for.
steps[].reasonsrequired: array of object
Why not (empty when allowed).
steps[].reasons[].coderequired: string
steps[].reasons[].messagerequired: string
can_overriderequired: boolean

Example

{
  "guard_enabled": true,
  "current": {
    "status_id": "cmusrceel0000q7kaafxqi1om",
    "key": "string",
    "name": "string"
  },
  "checklist": [
    {
      "key": "string",
      "label": "string",
      "required": true,
      "done": true,
      "source": "manual",
      "manual": true
    }
  ],
  "steps": [
    {
      "status_id": "cmusrceel0000q7kaafxqi1om",
      "key": "string",
      "name": "string",
      "category": "string",
      "allowed": true,
      "needs_approval": true,
      "reasons": [
        {
          "code": "string",
          "message": "string"
        }
      ]
    }
  ],
  "can_override": true
}