Updates the content of the document with the specified id. | awork API

import requests
url = "https://api.awork.com/api/v1/documents/documentId/content"
files = { "content": "open('# Project Plan
This document outlines the project plan for Q3 initiatives.', 'rb')" }
headers = {"Authorization": "Bearer <token>"}
response = requests.put(url, files=files, headers=headers)
print(response.json())

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "createdOn": "2023-11-20T10:15:30.000Z",
  "createdBy": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "updatedOn": "2024-04-10T14:22:05.000Z",
  "updatedBy": "b4c0ffee-1234-5678-9abc-def123456789",
  "name": "Q3 Project Plan",
  "currentDocumentVersionId": "d94f3f01-2c3b-4f5a-9a1b-123456789abc",
  "documentSpaceId": "e7b8f9a0-1c2d-4e3f-8a9b-0c1d2e3f4a5b",
  "documentSpace": {
    "id": "e7b8f9a0-1c2d-4e3f-8a9b-0c1d2e3f4a5b",
    "createdOn": "2022-01-15T08:00:00.000Z",
    "createdBy": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "updatedOn": "2023-12-01T12:00:00.000Z",
    "updatedBy": "b4c0ffee-1234-5678-9abc-def123456789",
    "name": "Marketing Documents",
    "emoji": "📁",
    "color": "purple",
    "order": 2.5,
    "workspaceAccessLevel": "read",
    "contributors": [
      {
        "id": "c1a2b3d4-e5f6-7890-abcd-ef1234567890",
        "userId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
        "accessLevel": "manage",
        "firstName": "Lisa",
        "lastName": "Smith",
        "hasImage": true,
        "isDeactivated": false
      }
    ],
    "teams": [
      {
        "id": "d4e5f6a7-b8c9-0123-def4-56789abcdef0",
        "teamId": "f1e2d3c4-b5a6-7890-1234-56789abcdef0",
        "accessLevel": "read",
        "name": "Designers",
        "icon": "paintbrush",
        "color": "purple"
      }
    ]
  },
  "parentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "projectId": "b1c2d3e4-f5a6-7890-bcde-f1234567890a",
  "project": {
    "id": "b1c2d3e4-f5a6-7890-bcde-f1234567890a",
    "name": "Q3 Marketing Campaign",
    "createdBy": "a3bb189e-8bf9-3888-9912-ace4e6543002",
    "teams": [
      {
        "id": "d4e5f6a7-b8c9-0123-def4-56789abcdef0",
        "name": "Marketing Team"
      }
    ],
    "members": [
      {
        "id": "e1f2a3b4-c5d6-7890-efab-c1234567890d",
        "projectRoleId": "f1e2d3c4-b5a6-7890-1234-56789abcdef0",
        "userId": "a3bb189e-8bf9-3888-9912-ace4e6543002"
      }
    ],
    "isPrivate": true,
    "isExternal": false
  },
  "taskId": "c1d2e3f4-a5b6-7890-cdef-1234567890ab",
  "emoji": "📄",
  "isPrivate": false,
  "order": 3,
  "isExternal": false,
  "isHiddenForConnectUsers": false,
  "contributors": [
    {
      "id": "c1a2b3d4-e5f6-7890-abcd-ef1234567890",
      "userId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
      "accessLevel": "manage",
      "firstName": "Lisa",
      "lastName": "Smith",
      "hasImage": true,
      "isDeactivated": false,
      "documentId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "inheritedFromDocumentContributorId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "inheritedDocumentContributor": {
        "documentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "accessLevel": "read"
      }
    }
  ],
  "teams": [
    {
      "id": "d4e5f6a7-b8c9-0123-def4-56789abcdef0",
      "teamId": "f1e2d3c4-b5a6-7890-1234-56789abcdef0",
      "accessLevel": "read",
      "name": "Designers",
      "icon": "paintbrush",
      "color": "purple",
      "documentId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "inheritedFromDocumentToTeamId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "inheritedDocumentToTeam": {
        "documentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "accessLevel": "read"
      }
    }
  ],
  "workspaceAccessLevel": "read",
  "inheritedWorkspaceAccessFromDocumentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "inheritedWorkspaceAccessFromDocument": {
    "workspaceAccessLevel": "read"
  },
  "movedToTrashOn": "2024-01-15T09:30:00Z",
  "movedToTrashBy": "b4c0ffee-1234-5678-9abc-def123456789",
  "rootDocumentCreatedBy": "a3bb189e-8bf9-3888-9912-ace4e6543002"
}

Required Permissions

The user must have at least write permissions for the specified document.

<Check title="Required Permissions" icon="key">The user must have at least `write` permissions for the specified document.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

documentIdstringRequiredformat: "uuid"

The id of the document to update.

Request

This endpoint expects a multipart form containing a file.

contentfileRequired

The content of the document.

Response

idstringformat: "uuid"

The id of the entity.

createdOndatetime

The date this entity was created.

createdBystringformat: "uuid"

The id of the user who created this entity.

updatedOndatetime

The date this entity was last modified.

updatedBystringformat: "uuid"

The id of the user who last modified this entity.

namestring or null

The name of the document.

currentDocumentVersionIdstring or nullformat: "uuid"

The id of the current document version.

documentSpaceIdstring or nullformat: "uuid"

The id of the document space.

documentSpaceobject

parentIdstring or nullformat: "uuid"

The id of the document's parent document.

projectIdstring or nullformat: "uuid"

The id of the project this document references.

projectobject

taskIdstring or nullformat: "uuid"

The id of the task this document references.

emojistring or null

The emoji of the document.

isPrivateboolean

Whether the document is private.

orderdouble or null

The order of the document in either the list of private docs, the referenced document space or in the referenced project.

isExternalboolean

Whether the document belongs to an external project.

isHiddenForConnectUsersboolean

Whether the document is hidden for connect users.

contributorslist of objects or null

The contributors of this document.

teamslist of objects or null

The teams this document is connected to.

workspaceAccessLevelstring or null

Determines the level of access to this document granted to all workspace users. Can be either not set (no access), read, or manage.

inheritedWorkspaceAccessFromDocumentIdstring or nullformat: "uuid"

The id of the document the workspace access level permission has been inherited from.

inheritedWorkspaceAccessFromDocumentobject

movedToTrashOndatetime or null

The date the document has been moved to the trash

movedToTrashBystring or nullformat: "uuid"

The id of the user that moved the document to the trash.

rootDocumentCreatedBystringformat: "uuid"

The user id of the creator of the root document of this document's document tree.

Errors

400

Bad Request Error