Skip to content

Empty channel

POST
/channels/{channel_id}/empty

Schedules a background job that removes every entry from the channel. Requires an admin user token and a confirmation payload that matches the channel slug.

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)

Parameters

Path Parameters

channel_id*

Channel identifier (id or slug)

Typestring
Required

Request Body

application/json
JSON
{
"confirm": "string"
}

Responses

empty channel job scheduled

application/json
JSON
{
"status": "string",
"message": "string"
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Part of Nimbu, built by Zenjoy.