documents

Creates a document.

Changed on

Creates a document with optional HTML or Markdown content. Set contentFormat to html or markdown; HTML is the default. Exported Markdown uses hidden metadata to preserve safe editor structures during re-import.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

post/documents

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/documents
  • Auth: HTTP bearer

Request body multipart/form-data

namestring nullable

The name of the document.

documentSpaceIdstring uuid nullable

The id of the document space.

parentIdstring uuid nullable

The id of the document's parent document.

projectIdstring uuid nullable

The id of the project this document references.

taskIdstring uuid nullable

The id of the task this document references.

emojistring nullable

The emoji of the document.

isPrivateboolean

Whether the document is private.

ordernumber double nullable

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

workspaceAccessLevel'none' | 'read' | 'manage'

Determines the level of access to this document granted to all workspace users. Can be either null (inherited), none, read, or manage.

isHiddenForConnectUsersboolean nullable

Whether the document is hidden for connect users.

contentstring binary

The optional UTF-8 document content. Use Awork.Core.Models.Documents.Documents.DocumentPostForm.ContentFormat to select HTML or Markdown input.

contentFormat'html' | 'markdown'

The input format of Awork.Core.Models.Documents.Documents.DocumentPostForm.Content. Defaults to html. Canonical awork Markdown supports lossless re-import of safe editor content.

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

namestring nullable

The name of the document.

currentDocumentVersionIdstring uuid nullable

The id of the current document version.

documentSpaceIdstring uuid nullable

The id of the document space.

parentIdstring uuid nullable

The id of the document's parent document.

projectIdstring uuid nullable

The id of the project this document references.

taskIdstring uuid nullable

The id of the task this document references.

emojistring nullable

The emoji of the document.

isPrivateboolean

Whether the document is private.

ordernumber double nullable

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.

workspaceAccessLevelstring nullable

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

inheritedWorkspaceAccessFromDocumentIdstring uuid nullable

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

movedToTrashOnstring date-time nullable

The date the document has been moved to the trash

movedToTrashBystring uuid nullable

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

rootDocumentCreatedBystring uuid

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

Changes