---
title: "Create a channel"
method: POST
path: "/channels"
tags: ["Channels"]
---

# Create a channel

`POST /channels`

## Request

- Base URL: `https://api.fanheroapi.com`
- URL: `https://api.fanheroapi.com/channels`
- Auth: API key in header `apiKey`

## Headers

- `organization` string, required

## Request body

- CreateChannelInput
  - `name` string, required: Channel name
  - `description` string, required: Channel description
  - `kind` 'PUBLIC' | 'EXCLUSIVE' | 'PAYWALL' | 'PRIVATE' | 'GEOLOCKED' | 'AUTO', required: The access level of the channel (enum).
  - `status` 'PUBLISHED' | 'UNPUBLISHED': Channel status
  - `geofence` GeofenceObject
    - `countryCodes` string[]
    - `type` 'WHITELIST' | 'BLACKLIST'
  - `customization` CustomizationObject
    - `logo` object: Logo image
      - `light` ImageDetails, required
        - `imgPath` string, required: The path to the image.
        - `baseUrl` string, required: The base URL for the image.
      - `dark` ImageDetails, required
        - `imgPath` string, required: The path to the image.
        - `baseUrl` string, required: The base URL for the image.
    - `icon` object: Icon image
      - `light` ImageDetails, required
        - `imgPath` string, required: The path to the image.
        - `baseUrl` string, required: The base URL for the image.
      - `dark` ImageDetails, required
        - `imgPath` string, required: The path to the image.
        - `baseUrl` string, required: The base URL for the image.
    - `thumbnail` ImageDetails
      - `imgPath` string, required: The path to the image.
      - `baseUrl` string, required: The base URL for the image.
  - `entitlements` string[]: Array of product IDs
  - `menu` string: Menu ID
  - `password` string: Password
  - `thumbnail` string: Path to the thumbnail image file in cloud storage

## Response `201`

Channel created.

- ChannelRestOutput
  - `id` string: Channel ID
  - `name` string: Channel name
  - `slug` string: Channel slug
  - `organization` string: Organization ID
  - `description` string: Channel description
  - `status` string: Channel status
  - `geofence` GeofenceObject
    - `countryCodes` string[]
    - `type` 'WHITELIST' | 'BLACKLIST'
  - `customization` CustomizationObject
    - `logo` object: Logo image
      - `light` ImageDetails, required
        - `imgPath` string, required: The path to the image.
        - `baseUrl` string, required: The base URL for the image.
      - `dark` ImageDetails, required
        - `imgPath` string, required: The path to the image.
        - `baseUrl` string, required: The base URL for the image.
    - `icon` object: Icon image
      - `light` ImageDetails, required
        - `imgPath` string, required: The path to the image.
        - `baseUrl` string, required: The base URL for the image.
      - `dark` ImageDetails, required
        - `imgPath` string, required: The path to the image.
        - `baseUrl` string, required: The base URL for the image.
    - `thumbnail` ImageDetails
      - `imgPath` string, required: The path to the image.
      - `baseUrl` string, required: The base URL for the image.
  - `entitlements` string[]: Array of product IDs
  - `geofenceEntitlements` unknown[]: Geofence entitlements
    - unknown
  - `kind` string: The access level of the channel
  - `access` string: States if the channel is universally available or geolocked.

---

[API](https://skmtc.dev/fanhero/apis/headless-cms-endpoints.md) - [All operations](https://skmtc.dev/fanhero/apis/headless-cms-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/fanhero/apis/headless-cms-endpoints/revisions/fb8d50c05ee6?raw)