WorkItems

Run an action on a work item

Triggers an action on a work item: it runs the action through the work-type registry, persists the resulting state transition (when the action moves the item), then runs the async tasks declared for the entered state. Returns the updated work item. Rejected with 409 when the action does not apply to the item's current state (an illegal transition).

post/v2/work-items/{workItemId}/actions/{actionCode}

Request

  • Base URL: https://api-docs.proofserve.com
  • URL: https://api-docs.proofserve.com/v2/work-items/{workItemId}/actions/{actionCode}
  • Auth: none declared

Request body

fieldsobject nullable

Typed input for the action, keyed by field name. Fields required depend on the action: court pickup's assign requires an assignee string encoding the choice as user:<id> (a process server) or vendor:<id> (a vendor); submit requires a non-empty documentKeys array of staged upload keys (from POST /document-uploads).

Response

The updated work item.

Example response

{
  "data": {
    "workType": "court_pickup",
    "title": "Jefferson County Circuit Court · 24-CV-00123",
    "status": "ready_for_pickup",
    "instruction": "Call the court before heading there.",
    "documents": [
      {
        "kind": "scanned_copy",
        "kindLabel": "Scanned copy"
      }
    ],
    "lineItems": [
      {
        "description": "Court pickup fee"
      }
    ],
    "totalPayoutAmountCents": 2500
  },
  "meta": {
    "requestId": "req_8xKp2mN4"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.