Update a Document

put/public/v1/documents/{document}

Rename a Document, or replace the Document Categories assigned to it after upload. Send an empty categories array to remove every category from the Document. Omit a field to leave it unchanged — null is not accepted for either. name excludes the file extension, which is returned separately as file_extension.

put/public/v1/documents/{document}

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

Response

{
  "data": {
    "id": "d1c2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
    "name": "Service Agreement",
    "file_extension": "pdf",
    "created_at": "2024-01-15T10:30:00+00:00",
    "categories": [
      {
        "id": "c4a5b6c7-d8e9-40f1-a2b3-c4d5e6f7a8b9",
        "name": "Assessments"
      }
    ]
  }
}

Authorization

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

Path parameters

documentstringrequired
The document UUID

Body

application/json

namestringmax length 255
categoriesobject[]max items 100
▶Show 1 child attributesHide child attributes
- idstringrequired

Response

200application/json

DocumentResource

dataobjectrequired
▶Show 5 child attributesHide child attributes
- idstringrequired
  Example:d1c2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- namestringrequired
  Example:Service Agreement
- file_extensionstringrequired
  Example:pdf
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- categoriesobject[]required
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:c4a5b6c7-d8e9-40f1-a2b3-c4d5e6f7a8b9
  namestringrequired
  Example:Assessments

Errors

401Unauthenticated
403Authorization error
404Not found
422Validation error

Command Palette

Authorization

Path parameters

Body

Response

Errors