inCase Integration Documentation Help

Update Process Step

The following command block is an example of how to update a process step:

--incase-cmd {types:UPDATE_PROCESS_STEP} {caseReference:ABC123-1} {process:Sale} {step:Welcome Pack Received} --incase-cmd-end

Update Process Step Parameter Definitions

The following table describes the parameters that can be used in the update process step command block:

Parameter

Type

Required

Default

Repeatable

Description

brackets

Enum: {, [, <

No

{

No

The encapsulating brackets to use

notifySuccess

Email Address

No

No

Who to notify upon successful completion

notifyError

Email Address

No

Email Return Address

No

Who to notify of processing errors, if not specified then the email return address will be used

quietMode

True, False

No

False

No

If true then turn off all notifications

types

UPDATE_PROCESS_STEP

Yes

No

The type of command to be performed

caseReference

String

Yes

No

The case reference, a unique identifier you use to identify the case

process

String

Yes

No

The name of the process that the step is in that you would like to change

step

String

Yes

No

The name of the step that you would like to change

sender

String

No

The email sender

No

The sender of the notification that the process step has been completed, defaults to the sender of the email

completed

Boolean

No

True

No

Set to true or false according to whether you would like the process step set as completed or not

replyTo

Email Address

No

Yes or comma separated

Set this parameter if you would like to update the case reply to

sendPushNotification

Boolean

No

True

No

Whether to send a notification to the users devices

02 July 2026