API docs by Redocly

Client Channel API (1.0.0)

Download OpenAPI specification:Download

API for managing client channels - distribution channels for organizing and categorizing clients

Channel

Client channel management operations

Get all client channels

Retrieve a list of all client channels with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

string or Array of strings

Filter by channel ID(s)

search
string

Search text for channel name

string or Array of strings

Filter by channel name(s)

string or Array of strings

Filter by local name(s)

disabled
boolean

Filter by disabled status

from_updatedAt
integer <int64>

Filter channels updated after this timestamp

from__id
string

Filter channels with ID greater than this value

to__id
string

Filter channels with ID less than this value

Array of objects

Advanced sorting options

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    }
}

Create a new client channel

Create a new client channel

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Channel name (required)

local_name
string

Local/translated name

disabled
boolean

Whether the channel is disabled

object

Metadata for third-party integrations

company_namespace
Array of strings

Company namespaces this channel belongs to

Responses

Request samples

Content type
application/json
{
  • "name": "Retail Channel",
  • "local_name": "قناة التجزئة",
  • "disabled": false,
  • "integration_meta": {
    },
  • "company_namespace": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get a specific client channel

Retrieve a specific client channel by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Channel ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update a client channel

Update an existing client channel

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Channel ID

Request Body schema: application/json
name
string

Channel name

local_name
string

Local/translated name

disabled
boolean

Whether the channel is disabled

object

Metadata for third-party integrations

company_namespace
Array of strings

Company namespaces this channel belongs to

_id
string

Channel ID (for internal use)

createdAt
string <date-time>

Creation timestamp (for internal use)

updatedAt
string <date-time>

Last update timestamp (for internal use)

__v
integer

Version key (for internal use)

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Retail Channel",
  • "local_name": "قناة التجزئة المحدثة",
  • "disabled": false,
  • "integration_meta": {
    },
  • "company_namespace": [
    ],
  • "_id": "60f1b2b3c9e9a12345678901",
  • "createdAt": "2023-01-15T10:30:00.000Z",
  • "updatedAt": "2023-01-15T10:30:00.000Z",
  • "__v": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete a client channel

Delete an existing client channel

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Channel ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}