Skip to main content
POST
Create Channel

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Body

application/json

A channel provides real-time messaging and communication within the platform.

channelType
object | null
channelTypeId
string | null
createdByUser
object | null
isPrivate
boolean
kapEnabled
boolean
name
string

Display name of the channel.

organization
object | null

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

organizationId
string | null
project
object | null

A project groups related document stores, assistants, tasks, and processing pipelines within an organization.

projectId
string | null
suppressEvents
boolean
task
object | null

A task represents a unit of work in a document review workflow, with an assignee, status, and due date.

taskId
string | null

Response

Created Channel

A channel provides real-time messaging and communication within the platform.

changeSequence
integer<int32>
required

Optimistic locking version number.

channelType
object | null
required
channelTypeId
string | null
required
createdByUser
object | null
required
createdByUserId
string | null
required
createdOn
string<date-time>
required

Timestamp when the channel was created.

deleted
boolean
required
id
string
required

Unique identifier (UUID) for the channel.

isPrivate
boolean
required
kapEnabled
boolean
required
name
string
required

Display name of the channel.

organization
object | null
required

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

organizationId
string | null
required
project
object | null
required

A project groups related document stores, assistants, tasks, and processing pipelines within an organization.

projectId
string | null
required
suppressEvents
boolean
required
task
object | null
required

A task represents a unit of work in a document review workflow, with an assignee, status, and due date.

taskId
string | null
required
updatedOn
string<date-time>
required

Timestamp when the channel was last updated.

uuid
string
required

Secondary UUID identifier.

deletedDate
string<date-time> | null