# ChannelsApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addChannelSubscriber**](#addchannelsubscriber) | **POST** /channels/{channelId}/subscribers | Subscribe an account to a channel|
|[**cancelChannelContentPublishSchedule**](#cancelchannelcontentpublishschedule) | **DELETE** /channels/{channelId}/contents/{contentId}/schedule | Cancel a scheduled channel content publish|
|[**createChannel**](#createchannel) | **POST** /channels | Create a channel|
|[**createChannelContent**](#createchannelcontent) | **POST** /channels/{channelId}/contents | Create channel content|
|[**createChannelContentGuest**](#createchannelcontentguest) | **POST** /channels/{channelId}/contents/{contentId}/guests | Add a guest to channel content|
|[**deleteChannel**](#deletechannel) | **DELETE** /channels/{channelId} | Delete a channel|
|[**deleteChannelContent**](#deletechannelcontent) | **DELETE** /channels/{channelId}/contents/{contentId} | Delete channel content|
|[**deleteChannelContentGuest**](#deletechannelcontentguest) | **DELETE** /channels/{channelId}/contents/{contentId}/guests/{guestId} | Remove a guest from channel content|
|[**getChannel**](#getchannel) | **GET** /channels/{channelId} | Get a channel|
|[**getChannelActivities**](#getchannelactivities) | **GET** /channels/{channelId}/activities | List a channel\&#39;s activity feed|
|[**getChannelContent**](#getchannelcontent) | **GET** /channels/{channelId}/contents/{contentId} | Get a channel\&#39;s content item|
|[**getChannelContentActivities**](#getchannelcontentactivities) | **GET** /channels/{channelId}/contents/{contentId}/activities | List a content item\&#39;s activity feed|
|[**getChannelContentGuest**](#getchannelcontentguest) | **GET** /channels/{channelId}/contents/{contentId}/guests/{guestId} | Get a content item\&#39;s guest|
|[**getChannelContentGuests**](#getchannelcontentguests) | **GET** /channels/{channelId}/contents/{contentId}/guests | List a content item\&#39;s guests|
|[**getChannelContentLikes**](#getchannelcontentlikes) | **GET** /channels/{channelId}/contents/{contentId}/likes | List a content item\&#39;s likes|
|[**getChannelContents**](#getchannelcontents) | **GET** /channels/{channelId}/contents | List a channel\&#39;s content|
|[**getChannelSubscriber**](#getchannelsubscriber) | **GET** /channels/{channelId}/subscribers/{accountId} | Get a channel\&#39;s subscriber|
|[**getChannelSubscribers**](#getchannelsubscribers) | **GET** /channels/{channelId}/subscribers | List a channel\&#39;s subscribers|
|[**getChannels**](#getchannels) | **GET** /channels | List channels|
|[**getContents**](#getcontents) | **GET** /contents | List organization-wide channel content|
|[**getFeaturedChannels**](#getfeaturedchannels) | **GET** /channels/featured | List featured channels|
|[**removeAllChannelSubscribers**](#removeallchannelsubscribers) | **DELETE** /channels/{channelId}/subscribers | Remove all subscribers from a channel|
|[**removeChannelSubscriber**](#removechannelsubscriber) | **DELETE** /channels/{channelId}/subscribers/{accountId} | Remove a subscriber from a channel|
|[**revertChannelContentToDraft**](#revertchannelcontenttodraft) | **PUT** /channels/{channelId}/contents/{contentId}/revertToDraft | Revert channel content to draft|
|[**updateChannel**](#updatechannel) | **PUT** /channels/{channelId} | Update a channel|
|[**updateChannelContent**](#updatechannelcontent) | **PUT** /channels/{channelId}/contents/{contentId} | Update channel content|
|[**updateChannelContentGuest**](#updatechannelcontentguest) | **PUT** /channels/{channelId}/contents/{contentId}/guests/{guestId} | Update a content guest|
|[**updateChannelContentPublishSchedule**](#updatechannelcontentpublishschedule) | **POST** /channels/{channelId}/contents/{contentId}/schedule | Schedule channel content for publishing|
|[**updateChannelSubscriber**](#updatechannelsubscriber) | **PUT** /channels/{channelId}/subscribers/{accountId} | Update an account\&#39;s channel subscription|

# **addChannelSubscriber**
> AddChannelSubscriber200Response addChannelSubscriber(addChannelSubscriberRequest)

Adds the given account as a subscriber of the specified channel, requiring update permission on both channels and accounts.

### Example

```typescript
import {
    ChannelsApi,
    Configuration,
    AddChannelSubscriberRequest
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let addChannelSubscriberRequest: AddChannelSubscriberRequest; //

const { status, data } = await apiInstance.addChannelSubscriber(
    channelId,
    addChannelSubscriberRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **addChannelSubscriberRequest** | **AddChannelSubscriberRequest**|  | |
| **channelId** | [**string**] | The channel identifier | defaults to undefined|


### Return type

**AddChannelSubscriber200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **cancelChannelContentPublishSchedule**
> CreateChannelContent200Response cancelChannelContentPublishSchedule()

Cancels the pending scheduled publish date for a piece of channel content, requiring update permission on contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)

const { status, data } = await apiInstance.cancelChannelContentPublishSchedule(
    channelId,
    contentId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|


### Return type

**CreateChannelContent200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **createChannel**
> CreateChannel200Response createChannel(channelCreateInputs)

Creates a new content channel for the organization, requiring create permission on channels.

### Example

```typescript
import {
    ChannelsApi,
    Configuration,
    ChannelCreateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelCreateInputs: ChannelCreateInputs; //

const { status, data } = await apiInstance.createChannel(
    channelCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelCreateInputs** | **ChannelCreateInputs**|  | |


### Return type

**CreateChannel200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **createChannelContent**
> CreateChannelContent200Response createChannelContent(channelContentCreateInputs)

Creates a new content item (post) within the specified channel, requiring create permission on contents, and invalidates the channel\'s subscriber cache on success.

### Example

```typescript
import {
    ChannelsApi,
    Configuration,
    ChannelContentCreateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let channelContentCreateInputs: ChannelContentCreateInputs; //

const { status, data } = await apiInstance.createChannelContent(
    channelId,
    channelContentCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelContentCreateInputs** | **ChannelContentCreateInputs**|  | |
| **channelId** | [**string**] | The channel identifier | defaults to undefined|


### Return type

**CreateChannelContent200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **createChannelContentGuest**
> CreateChannelContentGuest200Response createChannelContentGuest(channelContentGuestCreateInputs)

Adds a guest (such as a speaker or host) to a specific content item within a channel, requiring update permission on contents, and returns the created guest record.

### Example

```typescript
import {
    ChannelsApi,
    Configuration,
    ChannelContentGuestCreateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let channelContentGuestCreateInputs: ChannelContentGuestCreateInputs; //

const { status, data } = await apiInstance.createChannelContentGuest(
    channelId,
    contentId,
    channelContentGuestCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelContentGuestCreateInputs** | **ChannelContentGuestCreateInputs**|  | |
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|


### Return type

**CreateChannelContentGuest200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteChannel**
> CreateAccountInvitations200Response deleteChannel()

Permanently deletes the specified channel and its association from the organization, requiring delete permission on channels.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)

const { status, data } = await apiInstance.deleteChannel(
    channelId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|


### Return type

**CreateAccountInvitations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteChannelContent**
> CreateAccountInvitations200Response deleteChannelContent()

Permanently deletes a specific content item from the given channel, requiring delete permission on contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)

const { status, data } = await apiInstance.deleteChannelContent(
    channelId,
    contentId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|


### Return type

**CreateAccountInvitations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteChannelContentGuest**
> CreateChannelContent200Response deleteChannelContentGuest()

Removes a specific guest (such as a speaker or host) from a content item within a channel, requiring update permission on contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let guestId: string; //The guest identifier (default to undefined)

const { status, data } = await apiInstance.deleteChannelContentGuest(
    channelId,
    contentId,
    guestId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|
| **guestId** | [**string**] | The guest identifier | defaults to undefined|


### Return type

**CreateChannelContent200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getChannel**
> CreateChannel200Response getChannel()

Retrieves a single channel by its ID or slug, requiring read permission on channels.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)

const { status, data } = await apiInstance.getChannel(
    channelId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|


### Return type

**CreateChannel200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getChannelActivities**
> GetAccountActivities200Response getChannelActivities()

Returns a paginated list of activity records posted to the given channel, optionally filtered by activity status, search term, and sort order, requiring read permission on channels and activities.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let status: ActivityStatus; //Filter by status (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getChannelActivities(
    channelId,
    status,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **status** | **ActivityStatus** | Filter by status | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetAccountActivities200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getChannelContent**
> CreateChannelContent200Response getChannelContent()

Retrieves a single piece of content belonging to the given channel by its content ID, requiring read permission on channels and contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)

const { status, data } = await apiInstance.getChannelContent(
    channelId,
    contentId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|


### Return type

**CreateChannelContent200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getChannelContentActivities**
> GetAccountActivities200Response getChannelContentActivities()

Returns a paginated list of activity records posted on a specific content item within a channel, optionally filtered by activity status and search term, requiring read permission on channels, contents, and activities.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let status: ActivityStatus; //Filter by status (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getChannelContentActivities(
    channelId,
    contentId,
    status,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|
| **status** | **ActivityStatus** | Filter by status | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetAccountActivities200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getChannelContentGuest**
> CreateChannelContentGuest200Response getChannelContentGuest()

Retrieves a single guest record for a specific content item within a channel by guest ID, requiring read permission on channels and contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let guestId: string; //The guest identifier (default to undefined)
let status: string; //Filter by status (optional) (default to undefined)

const { status, data } = await apiInstance.getChannelContentGuest(
    channelId,
    contentId,
    guestId,
    status
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|
| **guestId** | [**string**] | The guest identifier | defaults to undefined|
| **status** | [**string**] | Filter by status | (optional) defaults to undefined|


### Return type

**CreateChannelContentGuest200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getChannelContentGuests**
> GetChannelContentGuests200Response getChannelContentGuests()

Returns a paginated list of guests (e.g. speakers/panelists) associated with a specific content item within a channel, optionally filtered by search term and sort order, requiring read permission on channels and contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let status: string; //Filter by status (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getChannelContentGuests(
    channelId,
    contentId,
    status,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|
| **status** | [**string**] | Filter by status | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetChannelContentGuests200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getChannelContentLikes**
> GetChannelContentLikes200Response getChannelContentLikes()

Returns a paginated list of accounts that liked a specific content item within a channel, optionally filtered by search term and sort order, requiring read permission on channels and contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getChannelContentLikes(
    channelId,
    contentId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetChannelContentLikes200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getChannelContents**
> GetChannelContents200Response getChannelContents()

Returns a paginated list of content items belonging to the given channel, optionally filtered by featured status and search term, requiring read permission on channels and contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let featured: boolean; //Filter by featured (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getChannelContents(
    channelId,
    featured,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **featured** | [**boolean**] | Filter by featured | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetChannelContents200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getChannelSubscriber**
> AddChannelSubscriber200Response getChannelSubscriber()

Retrieves a single subscription record for the given account on the given channel, requiring read permission on channels and accounts.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let accountId: string; //The account identifier (default to undefined)

const { status, data } = await apiInstance.getChannelSubscriber(
    channelId,
    accountId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **accountId** | [**string**] | The account identifier | defaults to undefined|


### Return type

**AddChannelSubscriber200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getChannelSubscribers**
> GetChannelSubscribers200Response getChannelSubscribers()

Returns a paginated list of accounts subscribed to the given channel, optionally filtered by subscription status and searched by keyword; requires read permission on channels and accounts.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let status: string; //Filter by status (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getChannelSubscribers(
    channelId,
    status,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **status** | [**string**] | Filter by status | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetChannelSubscribers200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getChannels**
> GetChannels200Response getChannels()

Returns a paginated list of channels for the organization, optionally filtered by search term and sort order, requiring read permission on channels.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getChannels(
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetChannels200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getContents**
> GetChannelContents200Response getContents()

Returns a paginated list of content items (videos, audio, or articles) across all of the organization\'s channels, filterable by featured status, content type, and whether publish date is in the past or upcoming; requires read permission on contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let featured: boolean; //Filter by featured (optional) (default to undefined)
let type: 'video' | 'audio' | 'article'; //Filter by type (optional) (default to undefined)
let past: boolean; //Filter by past (optional) (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getContents(
    featured,
    type,
    past,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **featured** | [**boolean**] | Filter by featured | (optional) defaults to undefined|
| **type** | [**&#39;video&#39; | &#39;audio&#39; | &#39;article&#39;**]**Array<&#39;video&#39; &#124; &#39;audio&#39; &#124; &#39;article&#39;>** | Filter by type | (optional) defaults to undefined|
| **past** | [**boolean**] | Filter by past | (optional) defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetChannelContents200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getFeaturedChannels**
> GetChannels200Response getFeaturedChannels()

Returns a paginated list of channels marked as featured for the organization; requires read permission on channels.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getFeaturedChannels(
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetChannels200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **removeAllChannelSubscribers**
> CreateChannel200Response removeAllChannelSubscribers()

Unsubscribes every account currently subscribed to the specified channel, requiring update and delete permission on channels and accounts.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)

const { status, data } = await apiInstance.removeAllChannelSubscribers(
    channelId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|


### Return type

**CreateChannel200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **removeChannelSubscriber**
> AddChannelSubscriber200Response removeChannelSubscriber()

Unsubscribes a specific account from the given channel, requiring update permission on channels and accounts.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let accountId: string; //The account identifier (default to undefined)

const { status, data } = await apiInstance.removeChannelSubscriber(
    channelId,
    accountId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **accountId** | [**string**] | The account identifier | defaults to undefined|


### Return type

**AddChannelSubscriber200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **revertChannelContentToDraft**
> CreateChannelContent200Response revertChannelContentToDraft()

Changes a published or scheduled content item back to draft status, unpublishing it, requiring update permission on contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)

const { status, data } = await apiInstance.revertChannelContentToDraft(
    channelId,
    contentId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|


### Return type

**CreateChannelContent200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **updateChannel**
> CreateChannel200Response updateChannel(channelUpdateInputs)

Updates the properties of an existing channel, such as its name and settings, requiring update permission on channels.

### Example

```typescript
import {
    ChannelsApi,
    Configuration,
    ChannelUpdateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let channelUpdateInputs: ChannelUpdateInputs; //

const { status, data } = await apiInstance.updateChannel(
    channelId,
    channelUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelUpdateInputs** | **ChannelUpdateInputs**|  | |
| **channelId** | [**string**] | The channel identifier | defaults to undefined|


### Return type

**CreateChannel200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **updateChannelContent**
> CreateChannelContent200Response updateChannelContent(channelContentUpdateInputs)

Updates the fields of an existing content item within a channel, such as its title, body, or publish settings, requiring update permission on contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration,
    ChannelContentUpdateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let channelContentUpdateInputs: ChannelContentUpdateInputs; //

const { status, data } = await apiInstance.updateChannelContent(
    channelId,
    contentId,
    channelContentUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelContentUpdateInputs** | **ChannelContentUpdateInputs**|  | |
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|


### Return type

**CreateChannelContent200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **updateChannelContentGuest**
> CreateChannelContentGuest200Response updateChannelContentGuest(channelContentGuestUpdateInputs)

Updates a guest speaker or panelist record attached to a piece of channel content, such as their name, bio, title, company, or image, and requires update permission on contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration,
    ChannelContentGuestUpdateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let guestId: string; //The guest identifier (default to undefined)
let channelContentGuestUpdateInputs: ChannelContentGuestUpdateInputs; //

const { status, data } = await apiInstance.updateChannelContentGuest(
    channelId,
    contentId,
    guestId,
    channelContentGuestUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelContentGuestUpdateInputs** | **ChannelContentGuestUpdateInputs**|  | |
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|
| **guestId** | [**string**] | The guest identifier | defaults to undefined|


### Return type

**CreateChannelContentGuest200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **updateChannelContentPublishSchedule**
> CreateChannelContent200Response updateChannelContentPublishSchedule(body)

Sets or updates the future publish date for a piece of channel content, and optionally triggers email and push notifications when it goes live; requires update permission on contents.

### Example

```typescript
import {
    ChannelsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let contentId: string; //The content identifier (default to undefined)
let body: object; //

const { status, data } = await apiInstance.updateChannelContentPublishSchedule(
    channelId,
    contentId,
    body
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **object**|  | |
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **contentId** | [**string**] | The content identifier | defaults to undefined|


### Return type

**CreateChannelContent200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **updateChannelSubscriber**
> AddChannelSubscriber200Response updateChannelSubscriber(channelSubscriberUpdateInputs)

Updates the subscription settings, such as the activity notification preference, for a given account\'s subscription to a channel; requires update permission on both channels and accounts.

### Example

```typescript
import {
    ChannelsApi,
    Configuration,
    ChannelSubscriberUpdateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ChannelsApi(configuration);

let channelId: string; //The channel identifier (default to undefined)
let accountId: string; //The account identifier (default to undefined)
let channelSubscriberUpdateInputs: ChannelSubscriberUpdateInputs; //

const { status, data } = await apiInstance.updateChannelSubscriber(
    channelId,
    accountId,
    channelSubscriberUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **channelSubscriberUpdateInputs** | **ChannelSubscriberUpdateInputs**|  | |
| **channelId** | [**string**] | The channel identifier | defaults to undefined|
| **accountId** | [**string**] | The account identifier | defaults to undefined|


### Return type

**AddChannelSubscriber200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

