The rating column holds rating information for your item(s) which can be useful for ranking or assigning a grade to your item(s). Our API supports this column, so you can read and update the rating column via the API.

Reading the rating column

You can return the data in a rating column in two different formats. The text field will return the data as a simple string, and the value field will return the data as a JSON string.

  "text": "5",
  "value": "{\"rating\":5,\"changed_at\":\"2022-07-21T12:00:00.000Z\"}"

Updating the rating column

You can update a rating column with a JSON string. Simple string updates are not supported.

To update a rating column, send a number between 1 and your rating scale. You can update your rating scale in the column settings.

For example: "{\"rating\":5}"

mutation {
  change_multiple_column_values(item_id:11111, board_id:22222, column_values: "{\"rating12\" : {\"rating\" : 5}}") {
fetch ("", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY'
  body: JSON.stringify({
    query : "mutation ($myBoardId:Int!, $myItemId:Int!, $myColumnValues:JSON!) { change_multiple_column_values(item_id:$myItemId, board_id:$myBoardId, column_values: $myColumnValues) { id }}",
    variables : JSON.stringify({
      myBoardId: YOUR_BOARD_ID,
      myItemId: YOUR_ITEM_ID,
      myColumnValues: "{\"rating12\" : {\"rating\" : \"5\"}}"

You can find the Postman request to change the rating column here.

Clearing the rating column

You can clear the rating column using a change_multiple_column_values mutation.

mutation {
  change_multiple_column_values(item_id: 2973227073, board_id: 2973227049, column_values: "{\"rating\" : {}}") {


Have questions?

Join our developer community! You can share your questions and learn from fellow users and product experts.

Don’t forget to search before opening a new topic!