Create Case

The following command block is an example of how to create a case:

--incase-cmd
{types:CREATE_CASE}
{caseReference:ABC123-1}
{senderEmail:feeearner@example.com}
{owner:feeearner@example.com}
{replyTo:feeearner@example.com}
{title:Sale of Willow Close}
{caseType:Sale}
{processes:Sale}
{clientName:John Smith}
{clientEmail:john.smith@example.com}
{clientName:Jan Smith}
{clientEmail:jan.smith@example.com}
--incase-cmd-end

Create Case Parameter Definitions

The following table describes the parameters that can be used in the create case 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	CREATE_CASE	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
senderEmail	Email Address	Yes		No	The email address of the user creating the case
owner	Email Address	Yes		No	The case handler in charge of the case
replyTo	Email Address	Yes		Yes or comma separated	The email address of who should be notified of any case events
caseType	String	Yes		No	The type of case, this field is freeform and does not need to be pre configured
title	String	Yes		No	A brief description of the case, this will be shown prominently in the app for the client to identify the case
processes	Process Name	Yes		Yes or comma separated	The name of the process that you would like to assign to the case, processes must be pre configured on our systems
clientName	String	Yes		Yes	The clients name, there must be a clientName for every clientEmail, blank values are ignored
clientEmail	Email Address	Yes		Yes	The clients email address, there must be a clientEmail for every clientName, blank values are ignored
thirdPartyName	String	No		Yes	The third parties name, there must be a thirdPartyName for every thirdPartyEmail, blank values are ignored
thirdPartyEmail	Email Address	No		Yes	The third parties email address, there must be a thirdPartyEmail for every thirdPartyName, blank values are ignored
emailIntegrationTag	String	No	caseReference	No	Case Event notification emails contain the caseReference, the value used can be overridden using this parameter
introducerId	Integer	No		No	If you have been referred to us through an introducer, then please use the value that we have given you for this parameter
introducerReference	String	No		No	If you have been referred to us through an introducer, the introducers case reference
balance	Decimal	No		No	Documented for completeness, used as a custom field for a particular client, ignore this parameter

02 July 2026