Disable check

POST

/operations/cases/checks/disable/v1/:case_id

Adds a CheckEnum to the Case’s disabled_check_keys (operator override). The Checklist that enabled the check stays applied; the workflow’s effective set becomes enabled - disabled. Requires the CheckEnum to currently be in enabled_check_keys; otherwise 400. Existing check runs are untouched — operators dismiss them individually if they also want them out of summary counts. | authz: min_org_role=operator | (CaseChecksDisableReq) -> (bool)

Adds a CheckEnum to the Case's disabled_check_keys (operator override). The Checklist that enabled the check stays applied; the workflow's effective set becomes enabled - disabled. Requires the CheckEnum to currently be in enabled_check_keys; otherwise 400. Existing check runs are untouched — operators dismiss them individually if they also want them out of summary counts. | authz: min_org_role=operator | (CaseChecksDisableReq) -> (bool)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

case_idstringRequired

Request

This endpoint expects an object.

checkenumRequired

What is being verified.

Each member is a single, narrowly-scoped check that runs on a specific OperationsEventEnum, encoded in the event property (backed by _CHECK_EVENT_MAP below) — never stored separately, or the two can drift.

Each Check1 evaluation is keyed by (check, entity_id) on a Case; entity_id is the id of the entity in the event’s Domain.Entity.Action slug:

Event	entity_id
shipping.order.*	order_id
shipping.task_group.driver_assigned	task_group_id
shipping.task.completed	task_id
shipping.task_artifact.*	task_artifact_id

entity_type is intentionally not stored — it’s a strict function of check.event.entity (same drift-avoidance rationale as the removed event field). If you ever need it to differ (e.g. a check fires on task.completed but is logically about the parent task_group), the first answer is adding the right event; the escape hatch is promoting entity_type to its own _CHECK_ENTITY_MAP.

Response

Successful Response

Errors

422

Cases Disable Check V1request Unprocessable Entity Error

1	const url = 'https://localhost:8000/operations/cases/checks/disable/v1/case_id';
2	const options = {
3	method: 'POST',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{"check":"shipping.task_group.driver_assigned.insurance_valid"}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}