Domain Model
Resource Link
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| channelEndpointId | string | Yes | — | ID of the associated channel endpoint |
| externalChannelId | string | Yes | — | ID of the associated external channel |
| externalChannelName | string | No | — | External channel name |
| linkedRecordType | string | Yes | — | Linked record type |
| linkedRecordId | string | Yes | — | ID of the associated linked record |
| syncDirection | enum(platform_to_channel, channel_to_platform, bidirectional) | Yes | — | Sync direction |
| workspaceId | string | Yes | — | ID of the associated workspace |
| configJson | object | No | — | Config json |
| enabled | boolean | Yes | — | Enabled |
| visibilityMode | unknown | Yes | — | Visibility mode |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| channelEndpointId | string | Yes | — | ID of the associated channel endpoint |
| externalChannelId | string | Yes | — | ID of the associated external channel |
| externalChannelName | string | No | — | External channel name |
| linkedRecordType | string | Yes | — | Linked record type |
| linkedRecordId | string | Yes | — | ID of the associated linked record |
| syncDirection | enum(platform_to_channel, channel_to_platform, bidirectional) | Yes | "platform_to_channel" | Sync direction |
| workspaceId | string | Yes | — | ID of the associated workspace |
| configJson | object | No | — | Config json |
| enabled | boolean | Yes | true | Enabled |
| visibilityMode | unknown | No | — | Visibility mode |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| externalChannelId | string | No | — | ID of the associated external channel |
| externalChannelName | string | No | — | External channel name |
| syncDirection | enum(platform_to_channel, channel_to_platform, bidirectional) | No | — | Sync direction |
| configJson | object | No | — | Config json |
| enabled | boolean | No | — | Enabled |