Cognis
Docs

Put Doc Section By Id

PUT
/docs/sections/{docSectionId}

Public API endpoint: docs.putDocSectionById

Required scopes: org:docs:write

Authorization

bearerAuth
AuthorizationBearer <token>

API key (prefix: cogn_) from Account → Developer

In: header

Path Parameters

docSectionId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:3013/api/v1/docs/sections/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "success": true,
  "data": {
    "id": "40",
    "name": "Overview",
    "description": "High-level overview for this documentation library",
    "status": "draft",
    "slug": "overview",
    "sortIndex": 0,
    "embeddingsEnabled": false,
    "firstPageId": "123",
    "createdAt": "2025-01-01T19:42:28.687Z",
    "updatedAt": "2025-01-02T10:15:00.000Z",
    "orgId": "1",
    "docLibraryId": "30",
    "groups": [
      {
        "id": "50",
        "name": "Getting Started Guides",
        "sortIndex": 0,
        "createdAt": "2025-01-01T19:42:28.687Z",
        "updatedAt": "2025-01-02T10:15:00.000Z",
        "orgId": "1",
        "docLibraryId": "30",
        "sectionId": "40"
      }
    ]
  },
  "message": "Success",
  "traceId": "req_abc123"
}
{
  "success": false,
  "message": "Invalid data",
  "errors": [
    {
      "code": 400,
      "message": "Invalid data"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Unauthorized",
  "errors": [
    {
      "code": 401,
      "message": "Unauthorized"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Forbidden",
  "errors": [
    {
      "code": 403,
      "message": "Forbidden"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Not found",
  "errors": [
    {
      "code": 404,
      "message": "Not found"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Conflict",
  "errors": [
    {
      "code": 409,
      "message": "Conflict"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "string",
  "errors": [
    {
      "code": 0,
      "message": "string",
      "details": {}
    }
  ],
  "traceId": "string",
  "params": {},
  "readableMessage": "string"
}
{
  "success": false,
  "message": "Rate limit exceeded",
  "errors": [],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Unexpected error",
  "errors": [
    {
      "code": 500,
      "message": "Unexpected error"
    }
  ],
  "traceId": "req_xxx"
}