Create a Document Category

post/public/v1/document-categories

post/public/v1/document-categories

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/document-categories' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string"
}'

Response

{
  "data": {
    "id": "c4a5b6c7-d8e9-40f1-a2b3-c4d5e6f7a8b9",
    "name": "Assessments",
    "archived_at": "2025-01-01T00:00:00+00:00",
    "created_at": "2024-01-15T10:30:00+00:00"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Body

application/json

namestringrequiredmax length 255

Response

200application/json

DocumentCategoryResource

dataobjectrequired
▶Show 4 child attributesHide child attributes
- idstringrequired
  Example:c4a5b6c7-d8e9-40f1-a2b3-c4d5e6f7a8b9
- namestringrequired
  Example:Assessments
- archived_atstring | nullrequired
  Example:2025-01-01T00:00:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
422Validation error