AssignmentSimulation

object

atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
leadrequired: object
lead.idrequired: Id or null
Opaque record id.
lead.refrequired: string or null
lead.namerequired: string or null
rulesrequired: array of object
rules[].idrequired: Id
Opaque record id.
rules[].namerequired: string
rules[].positionrequired: integer
rules[].is_activerequired: boolean
rules[].resultrequired: "matched" | "no_match" | "inactive" | "not_reached"
rules[].via_sourcerequired: boolean
rules[].conditionsrequired: array of object
rules[].conditions[].textrequired: string
rules[].conditions[].passedrequired: boolean
rulerequired: object or null
rule.idrequired: Id
Opaque record id.
rule.namerequired: string
rule.methodrequired: string
rule.via_sourcerequired: boolean
candidatesrequired: array of object
candidates[].member_idrequired: Id
Opaque record id.
candidates[].namerequired: string
candidates[].eligiblerequired: boolean
candidates[].winnerrequired: boolean
candidates[].reasonrequired: "excluded" | "off" | "leave" | "cap" | "untouched" | "capacity" | … or null
candidates[].reason_labelrequired: string or null
candidates[].weightrequired: integer
candidates[].todayrequired: integer
candidates[].daily_caprequired: integer or null
candidates[].last_hourrequired: integer
candidates[].untouchedrequired: integer
candidates[].open_leadsrequired: integer
candidates[].lead_capacityrequired: integer or null
candidates[].on_shiftrequired: boolean
candidates[].shiftrequired: string
candidates[].app_seen_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
candidates[].fitsrequired: object
candidates[].fits.languagerequired: boolean
candidates[].fits.localityrequired: boolean
candidates[].fits.specializationrequired: boolean
outcomerequired: object
outcome.kindrequired: "assign" | "hold" | "pool" | "waiting" | "unmatched"
outcome.member_idrequired: Id or null
Opaque record id.
outcome.member_namerequired: string or null
outcome.methodrequired: string or null
outcome.textrequired: string
outcome.untilrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
relaxedrequired: boolean

Example

{
  "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
}

{ "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 }