MEmetorial
Documents

Update document by ID

Updates a specific document.

patch/documents/{document_id}

Request

  • Base URL
    https://api.metorial.com
  • Auth
    HTTP bearer

Path parameters

document_idstring required

Unique identifier of the document.

Headers

Metorial-Versionstring
Example:2025-01-01

Pin the dated API version for this request, e.g. 2025-01-01. Defaults to the version configured for the environment.

Request body

titlestring
contentstring

Response

Successful response

object'document' required

String representing the object's type

idstring required
status'active' | 'deleted' required
titlestring required
contentstring required
file_idstring required
parent_document_idstring nullable required
current_version_idstring nullable required
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "created_by": {
    "organization_actor": {
      "id": "omem_5fGhJkLmNpQrStUv",
      "organization_id": "org_7hNkPqRsTuVwXyZa",
      "name": "Alex Chen",
      "email": "alex.chen@acme.com",
      "image_url": "https://avatar-cdn.metorial.com/aimg_1234567890",
      "member": {
        "id": "ome_7hNkPqRsTuVwXyZa"
      },
      "teams": [
        {
          "id": "tm_3eFgHjKlMnPqRsTu",
          "name": "Engineering",
          "slug": "engineering",
          "assignment_id": "tmas_8jKlMnPqRsTuVwXy"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.