Create Doc

Create Doc allows you to create a new Doc in the Workspace.

post/api/v4/{workspace-slug}/documents

Request

  • Base URL: https://api.app.shortcut.com
  • URL: https://api.app.shortcut.com/api/v4/{workspace-slug}/documents
  • Auth: HTTP bearer

Path parameters

workspace-slugstring required

The slug for the Workspace.

Query parameters

fieldsstring

Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.

Request body

contentstring required

The content of the new Doc.

titlestring required

The title of the new Doc.

collection_idsstring[]

The IDs of Collections to add the new Doc to.

content_format'markdown' | 'html'

Format of the content being sent. Defaults to 'html'. If 'markdown', content will be converted to HTML for storage.

descriptionstring

An optional description for the Doc.

Response

Resource

$schemastring required

The URI for the json-schema for this response.

Changes

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