Object - Unlink

Type identifier: object:unlink Category: Object Operations

Description

Removes relationships between Records. Supports three modes: unlinking a single specific relationship, removing all outgoing relationships from a Record, or removing all incoming relationships to a Record.

Input Handles

Handle	Data Type	Required	Description
`trigger`	`trigger`	Yes	Initiates the unlink operation
`from`	`string`/`object`	Varies	Source Record ID (mode dependent)
`to`	`string`/`object`	Varies	Target Record ID (mode dependent)

Input Handle Details

`from`

Type: string (CUID2) or object with id property
Required:
- single mode: Yes
- unlinkAllTo mode: Yes
- unlinkAllFrom mode: No
Notes: Source Record for the relationship

`to`

Type: string (CUID2) or object with id property
Required:
- single mode: Yes
- unlinkAllTo mode: No
- unlinkAllFrom mode: Yes
Notes: Target Record for the relationship

Output Handles

Handle	Data Type	Description
`success`	`trigger`	Triggered when unlink succeeds
`error`	`trigger`	Triggered on any error

Configuration Options

Property	Type	Required	Default	Description
`label`	`string`	Yes	`"Object - Unlink"`	Display label for the node
`schemaId`	`string`	Yes	`""`	Schema ID (for filtering)
`relationshipVersionId`	`string`	Yes	`""`	CUID2 of the relationship version
`mode`	`string`	No	`"single"`	Unlink mode

Configuration Details

`mode`

Type: "single" | "unlinkAllFrom" | "unlinkAllTo"
Options:
- single: Unlink specific relationship (requires both from and to)
- unlinkAllTo: Remove all outgoing relationships from the Record (requires from)
- unlinkAllFrom: Remove all incoming relationships to the Record (requires to)

Behaviour

Mode Behaviours

Mode	Required Inputs	Effect
`single`	`from` + `to`	Removes specific relationship
`unlinkAllTo`	`from` only	Removes all relationships where the Record is the source
`unlinkAllFrom`	`to` only	Removes all relationships where the Record is the target

Error Handling

Scenario	Behaviour
Required input resolution fails	Triggers `error`
Invalid ID format	Triggers `error`
No relationships found	Still triggers `success` (0 removed)

Examples

Unlink Single Relationship

{
  "type": "object:unlink",
  "data": {
    "label": "Unlink Order from Customer",
    "schemaId": "order-schema-uuid",
    "relationshipVersionId": "order-customer-rel-uuid",
    "mode": "single"
  }
}

Removes the specific relationship between from and to Records.

Remove All Outgoing Relationships

{
  "type": "object:unlink",
  "data": {
    "label": "Remove All Customer Orders",
    "schemaId": "order-schema-uuid",
    "relationshipVersionId": "order-customer-rel-uuid",
    "mode": "unlinkAllTo"
  }
}

Removes all relationships where the from Record is the source.

Remove All Incoming Relationships

{
  "type": "object:unlink",
  "data": {
    "label": "Unassign All Tasks",
    "schemaId": "task-schema-uuid",
    "relationshipVersionId": "task-assignee-rel-uuid",
    "mode": "unlinkAllFrom"
  }
}

Removes all relationships where the to Record is the target.

Object - Link

Links a source Record (from) to a target Record (to) using a configured relationship version. Depending on relationship cardinality, the operation creates a relationship, repoints an existing relationship, or leaves an exact active relationship unchanged.

Object - Query Link

Queries relationships between Records to find linked Records. Given either a source Record or target Record, finds the corresponding linked Record via a specific relationship type. Returns Record IDs for further processing.

Object - Remove

Removes Records that match filter criteria. Supports querying by any property and removes matching Records along with their relationships. Returns the removed Records for downstream processing.