Create a new channel

Create a channel. Requires Publisher Plus.

Keyword field name is keywords (not keyWords).

isPublic: Marked required in ChannelFields, but channel create drops required fields the caller cannot EDIT. Publisher / Publisher Plus have no EDIT on isPublic, so it is not required for those roles (omit it). Primis Admin / Account Manager must send isPublic.

Optional fields below (deleteAfterDays, level, rank, geo, dma, domains, domainTargeting, domainsAction, etc.) are included in the create schema for all roles (only required fields are permission-filtered). Create does not re-check field EDIT on write.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Channel name (1–80 chars; no backslashes)

string
enum
required
Allowed:
integer
required

Primis content category id (integer; string ids are also accepted by the API)

string
required
^[a-z]{2}$

ISO 639-1 language code (exactly 2 lowercase letters)

integer
enum
required
Allowed:
integer
enum
required
Allowed:
integer
enum
required
Allowed:
string
keywords
array of strings

Channel keywords (field name is keywords)

keywords
string
string
enum
Defaults to url

Type of channel source URL content

Allowed:
string
string
enum
Allowed:
integer

Geo-block flag (numeric), not a string like Allow

integer
enum

0 = private, 1 = public. Required for Admin/AM only; omit for Publisher / Publisher Plus (not present in their create schema).

Allowed:
integer | null
≥ -1

Days until content deletion; omit/null for unlimited. Min -1.

string
enum

MRSS priority level

Allowed:
integer
enum

Channel rank (API field rank, not folder_rank)

Allowed:
geo
array of strings

Geo localisation codes, or all

geo
dma
array of integers

DMA targeting codes (typically when geo includes US)

dma
integer
enum

0 = allowlist, 1 = blocklist

Allowed:
string

Domains list upload reference / CSV identifier used with domainsAction

string
enum

Action to apply with domains

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json