Sign in

v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB
Channels

Create a channel

post/channels

Headers

organizationstring required

The URL of the end-user web application

Request body

namestring required

Channel name

descriptionstring required

Channel description

kind'PUBLIC' | 'EXCLUSIVE' | 'PAYWALL' | 'PRIVATE' | 'GEOLOCKED' | 'AUTO' required

The access level of the channel (enum).

status'PUBLISHED' | 'UNPUBLISHED'

Channel status

entitlementsstring[]

Array of product IDs

menustring

Menu ID

passwordstring

Password

thumbnailstring

Path to the thumbnail image file in cloud storage

Example request

{
  "name": "FanHero Valorant",
  "description": "This is a channel dedicated to stream of CS:GO",
  "kind": "EXCLUSIVE",
  "status": "PUBLISHED",
  "customization": {
    "logo": {
      "light": {
        "imgPath": "image/path",
        "baseUrl": "server.com"
      },
      "dark": {
        "imgPath": "image/path",
        "baseUrl": "server.com"
      }
    },
    "icon": {
      "light": {
        "imgPath": "image/path",
        "baseUrl": "server.com"
      },
      "dark": {
        "imgPath": "image/path",
        "baseUrl": "server.com"
      }
    },
    "thumbnail": {
      "imgPath": "image/path",
      "baseUrl": "server.com"
    }
  },
  "entitlements": [
    "5fbed4f6c4f0c56a9b63ad27"
  ],
  "menu": "61bdd71f41e298e5a8bfa804",
  "password": "$2a$10$FIq2vF2eOMNe3wUT7d3aQusCn6zYtSDabMtMDTRFxAsRXt4CzCc52"
}

Response

Channel created.

idstring

Channel ID

namestring

Channel name

slugstring

Channel slug

organizationstring

Organization ID

descriptionstring

Channel description

statusstring

Channel status

entitlementsstring[]

Array of product IDs

kindstring

The access level of the channel

accessstring

States if the channel is universally available or geolocked.

Example response

{
  "id": "3649593763a63ab59e096487",
  "name": "Your Channel",
  "slug": "your-channel",
  "organization": "639cfa9a3efc39a89a96d6dw",
  "description": "Channel description",
  "status": "PUBLISHED",
  "customization": {
    "logo": {
      "light": {
        "imgPath": "image/path",
        "baseUrl": "server.com"
      },
      "dark": {
        "imgPath": "image/path",
        "baseUrl": "server.com"
      }
    },
    "icon": {
      "light": {
        "imgPath": "image/path",
        "baseUrl": "server.com"
      },
      "dark": {
        "imgPath": "image/path",
        "baseUrl": "server.com"
      }
    },
    "thumbnail": {
      "imgPath": "image/path",
      "baseUrl": "server.com"
    }
  },
  "kind": "PRIVATE",
  "access": "AVAILABLE"
}