AssignmentRule

object

idrequired: Id
Opaque record id.
namerequired: string
positionrequired: integer
1 = evaluated first.
priorityrequired: integer
is_activerequired: boolean
methodrequired: AssignmentMethod
conditionsrequired: AssignmentRuleConditions
summaryrequired: string
The conditions in words.
only_availablerequired: boolean
active_app_minutesrequired: integer or null
outside_shiftrequired: "assign" | "hold"
daily_caprequired: integer or null
max_untouchedrequired: integer or null
rotation_enabledrequired: boolean
rotation_minutesrequired: integer
rotation_maxrequired: integer
rotation_finalrequired: "pool" | "keep"
rotation_scoperequired: "auto" | "all" | "off"
second_chance_enabledrequired: boolean
second_chance_hoursrequired: integer
second_chance_attemptsrequired: integer
fallback_member_idrequired: Id or null
Opaque record id.
membersrequired: array of object
members[].member_idrequired: Id
Opaque record id.
members[].namerequired: string
members[].enabledrequired: boolean
members[].weightrequired: integer
members[].daily_caprequired: integer or null
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

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

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