monday doc

Learn how to read, update, and clear the monday doc column on boards using the platform API

The monday doc column stores Workdocs directly inside an item. Workdocs are collaborative documents that teams can edit together in real time.

Via the API, the monday doc column supports read, update, create, and clear operations.

Column Type

Implementation Type

Supported Operations

doc

DocValue

  • Read: Yes
  • Filter: No
  • Create: Yes
  • Update: Yes
  • Clear: Yes

Queries

monday doc columns can be queried through the column_values field on items queries using an inline fragment on DocValue.

query {
  items(ids: [1234567890, 9876543210]) {
    column_values {
      ... on DocValue {
        file
      }
    }
  }
}

Fields

You can use the following fields to specify what information your DocValue implementation will return.

FieldDescription
column Column!The column the value belongs to.
file FileDocValueThe Workdoc stored in the column.
id ID!The column's unique identifier.
text StringAlways returns "".
type ColumnType!The column's type.
value JSONThe column's JSON-formatted raw value.

Mutations

Create

Required scope:boards:write

The create_column mutation creates a monday doc column via the API. You can specify which fields to return in the mutation response.

mutation {
  create_column(
    board_id: 1234567890
    column_type: doc
    title: "Task info"
  ) {
    id
    title
    type
  }
}

Create a doc inside a doc column

Required scope:docs:write

The create_doc mutation creates a doc inside a monday doc column via the API. You can specify which fields to return in the mutation response.

mutation {
  create_column(
    board_id: 1234567890
    column_type: doc
    title: "Task info"
  ) {
    id
    title
    type
  }
}

Clear

You can clear a monday doc column using change_column_value by passing "{\"clear_all\": true}" in value.

Clearing the column removes the associated Workdoc link from the item, but it doesn't delete the doc itself.

mutation {
  change_column_value(
    board_id: 1234567890
    item_id: 9876543210
    column_id: "monday_doc"
    value: "{\"clear_all\": true}"
  ) {
    id
  }
}