Create a new section | Documentation

Section Create a new section

POST

/control-plane/api/v1/v1/documentation/{organization_id}/{documentation_id}/version/{version_id}/section

Authentication

API Key (BearerAuth)

Header: Authorization

Path Parameters

organization_idstringrequired

Organization ID

documentation_idstringrequired

Documentation ID

version_idstringrequired

Version ID

Request Body

Section input

Required

iconstring

namestringrequired

orderinteger

promptstring

slugstringrequired

typestringrequired

visibleboolean

Example:

{
  "icon": "string",
  "name": "string",
  "order": 0,
  "prompt": "string",
  "slug": "string",
  "type": "product_documentation",
  "visible": true
}

Responses

201

Created

Response Fields:

created_at (string)
icon (string)
id (string)
name (string)
order (integer)
prompt (string)
slug (string)
type (string)
updated_at (string)
version_id (string)
visible (boolean)

Example:

{
  "created_at": "string",
  "icon": "string",
  "id": "string",
  "name": "string",
  "order": 0,
  "prompt": "string",
  "slug": "string",
  "type": "product_documentation",
  "updated_at": "string",
  "version_id": "string",
  "visible": true
}

400

Bad Request

Example:

{
  "key": "value"
}

500

Internal Server Error

Example:

{
  "key": "value"
}