monday.com updates contain additional notes and information added to items outside of their columns. Updates allow users to organize communication across their organization and respond asynchronously. For many users, the updates section is their primary form of communication within the platform.

As a developer working with monday.com, it is important to familiarize yourself with the updates API so you know how to access data in updates. This document will walk you through the available queries and mutations to read and modify the updates object via the API.

Queries

Required scope: updates:read

Querying updates will return metadata about one or a collection of updates. This method accepts various arguments and returns an array.

You can use updates directly at the root of your query to return all updates across an account. Alternatively, you can nest updates within another query to only return updates from a specific board or item. They will be returned in descending order from the most recently created update to the oldest, and you can retrieve up to 10,000 updates via the API.

query {
  updates (limit: 100) {
    body
    id
    created_at
    creator {
      name
      id
    }
  }
}
let query = "query {updates (limit: 100) { body id  created_at  creator { name id } }}";

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments

You can use the following argument(s) to reduce the number of results returned in your updates query.

ArgumentDescription
ids [ID!]The specific ID(s) to return updates for.
limit IntThe number of updates to return. The default is 25.
page IntThe page number to get. Starts at 1.

Fields

You can use the following field(s) to specify what information your updates query will return. Please note that some fields will have their own fields.

FieldDescriptionSupported fields
assets [Asset]The update's assets/files.created_at Date
file_extension String!
file_size Int!
id ID!
name String!
original_geometry String
public_url String!
uploaded_by User!
url String!
url_thumbnail String
body String!The update's HTML-formatted body.
created_at DateThe update's creation date.
creator UserThe update's creator.
creator_id StringThe unique identifier of the update's creator.
id ID!The update's unique identifier.
item_id StringThe update's item ID.
replies [Reply]The update's replies.body String!
created_at Date
creator User
creator_id String
id ID!
text_body String
updated_at Date
text_body StringThe update's text body.
updated_at DateThe update's last edit date.

Mutations

Required scope: updates:write

Create an update

The create_update mutation allows you to add an update to an item via the API. You can also specify what fields to query back from the new update when you run the mutation.

mutation {
  create_update (item_id: 1234567890, body: "This update will be added to the item") {
    id
  }
}
let query = "mutation {create_update (item_id: 1234567890, body: \"This update will be added to the item\") { id }}";

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments

You can use the following argument(s) to define the new update's characteristics.

ArgumentDescription
body String!The update's text.
item_id IDThe item's unique identifier.
parent_id IDThe parent update's unique identifier. This can be used to create a reply to an update.

Like an update

The like_update mutation allows you to like an update via the API. You can also specify what fields to query back from the update when you run the mutation.

mutation {
  like_update (update_id: 1234567890) {
    id
  }
}
let query = "mutation { like_update (update_id: 1234567890) { id }}";

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments

You can use the following argument(s) to define which update to like.

ArgumentDescription
update_id IDThe unique identifier of the update to like.

Clear an item's updates

The clear_item_updates mutation allows you to clear all updates on a specific item, including replies and likes, via the API. You can also specify what fields to query back from the update when you run the mutation.

mutation {
  clear_item_updates (item_id: 1234567890) {
    id
  }
}
let query = "mutation { clear_item_updates (item_id: 1234567890) { id }}";

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments

You can use the following argument(s) to define which item's updates to clear.

ArgumentsDescription
item_id ID!The item's unique identifier.

Delete an update

The delete_update mutation allows you to delete an item's update via the API. You can also specify what fields to query back from the update when you run the mutation.

mutation {
  delete_update (id: 1234567890) {
    id
  }
}
let query = "mutation { delete_update (id: 1234567890) { id }}";

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
   },
   body: JSON.stringify({
     query : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

Arguments

You can use the following argument(s) to define which updates to delete.

ArgumentDescription
id ID!The update's unique identifier.

πŸ“˜

Join our developer community!

We've created a community specifically for our devs where you can search through previous topics to find solutions, ask new questions, hear about new features and updates, and learn tips and tricks from other devs. Come join in on the fun! 😎