Object - Unlink
Type identifier:
object:unlinkCategory: 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 |
|---|---|---|---|
|
| Yes | Initiates the unlink operation |
|
| Varies | Source Record ID (mode dependent) |
|
| Varies | Target Record ID (mode dependent) |
Input Handle Details
from
- Type:
string(CUID2) or object withidproperty Required:
singlemode: YesunlinkAllTomode: YesunlinkAllFrommode: No
- Notes: Source Record for the relationship
to
- Type:
string(CUID2) or object withidproperty Required:
singlemode: YesunlinkAllTomode: NounlinkAllFrommode: Yes
- Notes: Target Record for the relationship
Output Handles
Handle | Data Type | Description |
|---|---|---|
|
| Triggered when unlink succeeds |
|
| Triggered on any error |
Configuration Options
Property | Type | Required | Default | Description |
|---|---|---|---|---|
|
| Yes |
| Display label for the node |
|
| Yes |
| Schema ID (for filtering) |
|
| Yes |
| CUID2 of the relationship version |
|
| No |
| Unlink mode |
Configuration Details
mode
- Type:
"single"|"unlinkAllFrom"|"unlinkAllTo" Options:
single: Unlink specific relationship (requires bothfromandto)unlinkAllTo: Remove all outgoing relationships from the Record (requiresfrom)unlinkAllFrom: Remove all incoming relationships to the Record (requiresto)
Behaviour
Mode Behaviours
Mode | Required Inputs | Effect |
|---|---|---|
|
| Removes specific relationship |
|
| Removes all relationships where the Record is the source |
|
| Removes all relationships where the Record is the target |
Error Handling
Scenario | Behaviour |
|---|---|
Required input resolution fails | Triggers |
Invalid ID format | Triggers |
No relationships found | Still triggers |
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.