Update document metadata

Partially update a document’s metadata. Send only the fields you want to change.

• tags: Array of tag IDs (UUIDs) to assign to the document. This replaces the document’s current tag set, so you can add or remove tags by including the full list you want applied. Each ID must refer to an existing tag (use POST /contents/v1/tags to create one, or GET /contents/v1/tags to list IDs). If any ID is invalid, the API returns 400 with error code INVALID_TAGS_ERROR.
• share_with_org: When true, the document is available to all members of your organization. When false, only you can access it.

PATCH /contents/v1/documents/{content_id}

cURL

Replace document tags

curl --request PATCH \
  --url https://api.bigdata.com/contents/v1/documents/{content_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "tags": [
    "019e3a99-6952-7dd4-adf5-b0b341959e11"
  ]
}
'

200

{
  "id": "E0618D0E9D3A960C1731A620EDE56B5C",
  "file_name": "Weekly summary report.eml",
  "user_id": "user_id_001",
  "org_id": "org_id_001",
  "status": "pending",
  "created_at": "2026-02-03T08:43:02.729356Z",
  "updated_at": "2026-02-03T08:43:02.729359Z",
  "published_at": "2026-02-03T08:43:02.729359Z",
  "rp_collection_id": "2CBDC7DA8AE42A8A078DECC3C9FCADFB",
  "rp_source_id": "E5A77C",
  "raw_size": 18974,
  "pages": 50,
  "request_origin": "email",
  "content_type": "message/rfc822",
  "shared_with_orgs": [
    "org_id_001"
  ],
  "connector_id": "019a9612-bfad-758c-884e-37dd8c6ad2cb",
  "error_code": null,
  "delete_started_ts": null,
  "file_metadata": null,
  "tags": [
    {
      "id": "019a48b4-e574-71d9-a8d9-6a5a86386847",
      "name": "from:[e-mail]"
    }
  ],
  "usage": {
    "private_data_tokens": 171079
  },
  "enrichments_requested": [
    "translation"
  ],
  "enrichments_applied": []
}

Authorizations

X-API-KEY · string · header · required

Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.

Path Parameters

content_id · string · required

Content ID of the document to update (32-character uppercase hexadecimal string).

Pattern: ^[A-F0-9]{32}$

Example:

"E0618D0E9D3A960C1731A620EDE56B5C"

Body

application/json

Fields to update on a document. Include only the properties you want to change.

tags · string<uuid>[]

Tag IDs to assign to the document. Replaces the current tag assignment. Every ID must exist; otherwise the API returns INVALID_TAGS_ERROR.

Example:

["019e3a99-6952-7dd4-adf5-b0b341959e11"]

share_with_org · boolean

If true, all members of your organization can access the document. If false, only you can access it.

Example:

false

Response

200

application/json

Updated document metadata.

Metadata for a single document. Returned by List documents and Get document. Use the id (content_id) with Get annotated document or Get original document to retrieve the file content.

id · string · required

Content ID: unique 32-character uppercase hexadecimal identifier for the document. Use this when calling Get document, Get annotated document, or Get original document.

Example:

"E0618D0E9D3A960C1731A620EDE56B5C"

file_name · string · required

Original file name of the uploaded document.

Example:

"Weekly summary report.eml"

user_id · string · required

ID of the user who uploaded the document.

Example:

"user_id_001"

org_id · string · required

ID of the organization the document belongs to.

Example:

"org_id_001"

status · enum<string> · required

Processing status of the document.

Available options: pending, processing, completed, failed

created_at · string<date-time> · required

Timestamp when the document was created.

Example:

"2026-02-03T08:43:02.729356Z"

updated_at · string<date-time> · required

Timestamp when the document was last updated.

Example:

"2026-02-03T08:43:02.729359Z"

published_at · string<date-time> · required

Timestamp when the document was published. This is the reference timestamp used for search and retrieval.

Example:

"2026-02-03T08:43:02.729359Z"

rp_collection_id · string | null

ID of the collection the document belongs to. This is applicable only for emails and attachments.

Example:

"2CBDC7DA8AE42A8A078DECC3C9FCADFB"

rp_source_id · string | null

Identifier of the RavenPack source associated with this document. This source is used to filter documents in the Search and Research Agent.

Example:

"E5A77C"

raw_size · integer

Size of the raw document in bytes.

Example:

18974

pages · integer | null

Number of pages in the document when page count is available (for example PDFs).

Example:

50

request_origin · enum<string>

Origin of the content ingestion request: how the document entered the platform.

Available options: email, investment_research, sharepoint, file_upload

content_type · string

MIME type of the document.

Example:

"message/rfc822"

shared_with_orgs · string[]

List of organization IDs the document is shared with.

Example:

["org_id_001"]

connector_id · string<uuid> | null

ID of the connector used to upload the document.

Example:

"019a9612-bfad-758c-884e-37dd8c6ad2cb"

error_code · string | null

Error code if the document processing failed.

Example:

null

delete_started_ts · string<date-time> | null

Timestamp when document deletion started, if applicable.

Example:

null

file_metadata · object | null

Additional metadata about the file.

Example:

null

tags · object[]

Tags associated with the document.

Show child attributes

usage · object

Usage metering for a private document (Private Content Storage).

Show child attributes

enrichments_requested · enum<string>[]

Enrichments requested for this document (from direct upload or the connector that ingested it). See Enrichments.

Available options: reporting_entities, translation

Example:

["translation"]

enrichments_applied · enum<string>[]

Enrichments that were successfully applied during processing. Compare with enrichments_requested to see what is still pending or was not applied.

Available options: reporting_entities, translation

Example:

[]