Skip to content

Create channel​

POST
/channels

Creates a new channel with the provided name, slug, and settings.

Authorizations​

bearerToken|siteContext
bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)
+
siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)
or
siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Request Body​

application/json
JSON
{
"name": "string",
"slug": "string",
"description": "string",
"sensitive": true,
"submittable": true,
"label_field": "string",
"title_field": "string",
"order_by": "string",
"order_direction": "string",
"customizations": [
{
"name": "string",
"label": "string",
"hint": "string",
"type": "string",
"required": true,
"localized": true,
"select_options": [
{
"id": "string",
"name": "string",
"label": "string",
"slug": "string",
"position": 0
}
]
}
]
}

Responses​

channel created

application/json
JSON
{
"id": "string",
"url": "string",
"entries_url": "string",
"slug": "string",
"name": "string",
"description": "string",
"created_at": "string",
"updated_at": "string",
"sensitive": true,
"acl": {
},
"submittable": true,
"rss_enabled": true,
"label_field": "string",
"title_field": "string",
"order_by": "string",
"order_direction": "string",
"entries_custom_fields": [
{
}
],
"additionalProperties": "string"
}

Playground​

Authorization
Body

Samples​