CreateCase

typed block

Creates a new case using an existing case template. Templates come with predefined fields, some of which are required and will appear in a side panel when you start. You can review and fill in the required fields, and optionally update any other available fields based on your needs. These fields are set up in your instance ahead of time. You can also choose to link a contact to the new case if needed.

Factories

`CreateCase`

CreateCase() -> CreateCaseHandle

Construct a fresh CreateCase block with an auto-generated id.

Use this when authoring from scratch, the runtime picks a UUID automatically.

`CreateCase`

CreateCase(id: String) -> CreateCaseHandle

Construct a CreateCase block with an operator-supplied id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier, typically a Connect UUID restored by `decompile` so round-trips stay byte-stable.

Methods

`link_contact_to_case`

link_contact_to_case(value: String) -> CreateCaseHandle

Set the LinkContactToCase parameter. "true" or "false"; when true, the case opens when the agent accepts the contact.

Parameter	Type	Required	Description
`value`	`String`	yes	"true" or "false"; when true, the case opens when the agent accepts the contact.

`case_template_id`

case_template_id(value: String) -> CreateCaseHandle

Set the CaseTemplateId parameter. The case template's id.

Parameter	Type	Required	Description
`value`	`String`	yes	The case template's id.

`case_request_fields`

case_request_fields(value?: Map<String, String>) -> CreateCaseHandle

Set the CaseRequestFields parameter. Case fields to set, keyed by Cases field; values static or dynamic.

Parameter	Type	Required	Description
`value`	`Map<String, String>`	no	Case fields to set, keyed by Cases field; values static or dynamic.

`next`

next(target: Handle) -> CreateCaseHandle

Wire the success-path transition. Substitutes the target's auto-generated UUID into the wire Transitions.NextAction slot.

Parameter	Type	Required	Description
`target`	`Handle`	yes	The block to route to once this block completes successfully.

`on_contact_not_linked`

on_contact_not_linked(target: Handle) -> CreateCaseHandle

Wire an error transition for ContactNotLinked: If you specify to link the contact to case, then this error branch will appear. It might be that the contact was not linked after the case is retrieved (partial success/partial failure). If this happens, then the flow will follow this branch.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `ContactNotLinked`. If you specify to link the contact to case, then this error branch will appear. It might be that the contact was not linked after the case is retrieved (partial success/partial failure). If this happens, then the flow will follow this branch.

`on_no_matching`

on_no_matching(target: Handle) -> CreateCaseHandle

Wire an error transition for NoMatchingError: An error was encountered while trying to find the case. This may be due to a system error or how CreateCase is configured.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingError`. An error was encountered while trying to find the case. This may be due to a system error or how CreateCase is configured.

`set_id`

set_id(id: String) -> CreateCaseHandle

Override the auto-generated identifier with a specific wire id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier override. Decompile threads this through to round-trip Connect-side UUIDs.

`meta_position`

meta_position(x: i64, y: i64) -> CreateCaseHandle

Set the block's canvas position. Mostly auto-emitted by decompile; authored scripts call Flow.auto_layout() instead and let the layout pass fill positions in.

Parameter	Type	Required	Description
`x`	`i64`	yes	Canvas X coordinate.
`y`	`i64`	yes	Canvas Y coordinate.

`set_meta`

set_meta(key: String, value: Dynamic) -> CreateCaseHandle

Single-key escape hatch, set one ActionMetadata key by name when the typed meta_* setters don't cover it.

Parameter	Type	Required	Description
`key`	`String`	yes	Wire key name (under `Metadata.ActionMetadata[<id>]`).
`value`	`Dynamic`	yes	Any JSON-serializable Rhai value.

`overwrite_meta`

overwrite_meta(value: Map) -> CreateCaseHandle

Full-replace escape hatch, overwrite the entire ActionMetadata blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement map for the entire ActionMetadata sub-object.

`set_meta_param`

set_meta_param(param: String, flag: String, value: Dynamic) -> CreateCaseHandle

Set a single per-parameter ActionMetadata flag.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name (e.g. `"Text"`).
`flag`	`String`	yes	Flag name (`"useDynamic"`, `"MFLAG_*"`, etc.).
`value`	`Dynamic`	yes	Flag value.

`overwrite_meta_param`

overwrite_meta_param(param: String, value: Map) -> CreateCaseHandle

Replace the entire flag map for one parameter.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name.
`value`	`Map`	yes	Replacement flag map for the parameter.

`overwrite_parameters`

overwrite_parameters(value: Map) -> CreateCaseHandle

Wire-shape escape hatch, overwrite the entire Parameters blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement parameter map for the block.

`raw_transitions`

raw_transitions(value: Map) -> CreateCaseHandle

Wire-shape escape hatch for non-canonical transition objects.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement transitions map (raw JSON shape).