Skip to content

Create document class

Request

Creates a new document class with the specified name, optional description, and metadata references. Metadata definitions are managed through the document metadata endpoints.

Security
Bearer or PersonalAccessToken
Path
organizationIdstring, (uuid)required

Unique identifier of the organization

Bodyapplication/jsonrequired
namestringrequired

The document class name.

Example:"Contract"
descriptionstringrequired

The document class description.

Example:"Documents related to contracts"
metadataArray of objects(DocumentClassMetadataReferenceRequest)required

The metadata field references for this document class.

POST
/api/v1/organizations/{organizationId}/document-classes
curl -i -X POST \
  '/api/v1/organizations/{organizationId}/document-classes' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Contracts",
    "description": "Document class for contracts",
    "metadata": [
      {
        "id": "d4d97f11-d33d-4352-b75f-19015e186949",
        "sortOrder": 1,
        "required": true
      },
      {
        "id": "8b190436-0990-48b6-ae15-54ff6caddddf",
        "sortOrder": 2,
        "required": true
      },
      {
        "id": "ad48c6bc-de30-44e1-a32d-6e31332e96d0",
        "sortOrder": 3,
        "required": false
      }
    ]
  }'

Responses

Created

Bodyapplication/json
idstring, (uuid)required

The ID of the created document class.

Example:"048f2e2c-0f48-498b-953d-02d414c60baf"
Response
{ "id": "e40d5ec9-0689-4648-bf15-8332d937fa9b" }