Update Process Step

Use this endpoint to update the process step of a case.

/api/rest/{organisationId}/processes/step

Update a process step on the case.

Request parameters

{
  "externalCaseRef": "ABC123-1",
  "sender": "Barbara Jenkins",
  "replyTo": "case_handler@example.com",
  "processName": "Sale",
  "stepName": "Welcome Pack Received",
  "completed": true,
  "sendPushNotification": true
}

Responses

{
  "process": {
    "id": 91,
    "name": "example",
    "steps": [
      {
        "id": "example",
        "name": "example",
        "stage": "example",
        "comment": "example",
        "snippet": "example",
        "children": [
          "example"
        ],
        "progress": "example",
        "read_at": "1971-04-26T12:26:06Z",
        "icon_code": "example",
        "external_id": "example"
      }
    ],
    "case_id": 91,
    "start_step": "example",
    "created_at": "1971-04-26T12:26:06Z",
    "updated_at": "1971-04-26T12:26:06Z"
  }
}

02 July 2026