Skip to content
AcrivaDocs

UpdateDocumentMetadata

PUT
/api/v1/t/{tenant}/documents/{documentId}/metadata
curl --request PUT \
  --url https://example.com/api/v1/t/example/documents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/metadata \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "documentTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "metadata": "example" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

documentId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
title
required
string
documentTypeId
required
null | string format: uuid
metadata
required
One of:
null
Examplegenerated
{
  "title": "example",
  "documentTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "metadata": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
id
required
string format: uuid
title
required
string
documentTypeId
required
null | string format: uuid
status
required
Allowed values: Processing Active Archived Deleted Purging
metadata
required
isConfidential
required
boolean
processingFailed
required
boolean
isQuarantined
required
boolean
servedVersionNumber
required
null | integer format: int32
currentVersion
required
One of:
null
lockedBy
required
null | string format: uuid
lockedAt
required
null | string format: date-time
fileIds
required
Array<string>
tagIds
required
Array<string>
accessLevel
required
Allowed values: Read Write Manage
createdBy
required
string format: uuid
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
typeSource
required
One of:
null
metadataSources
required
object
key
additional properties
object
source
required
Allowed values: Person EInvoice Ai Workflow Computed
resultId
null | string format: uuid
split
One of:
null
retentionUntil
null | string format: date
legalHold
boolean
retentionApplies
boolean
retentionStale
boolean
provenance
One of:
null
Example
{
  "status": "Processing",
  "currentVersion": {
    "processingState": "Pending",
    "renditions": [
      {
        "kind": "PdfA"
      }
    ]
  },
  "accessLevel": "Read",
  "typeSource": {
    "source": "Person"
  },
  "metadataSources": {
    "additionalProperty": {
      "source": "Person"
    }
  },
  "legalHold": false,
  "retentionApplies": false,
  "retentionStale": false,
  "provenance": {
    "source": "Upload"
  }
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

409

Section titled “409”

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}