Connect boards

The connect boards column links an item on the board with item(s) on different board(s). Our API supports this column, so you can read and update the connect boards column via the API.

Reading the connect boards column

You can return the data in a connect boards 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": "Sample task",
  "value": "{\"linkedPulseIds\":[{\"linkedPulseId\":2977941089}]}"

Updating the connect boards column


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



Currently, to connect items using our API, the board(s) these items reside in (board B) must be connect to the current board (board A) manually.

If this step is not completed, an error will be raised.

To update a connect boards column, send the item IDs to be linked as an array. If the items sent do not belong to the board(s) that are connected, an exception will be raised.

mutation {
  change_multiple_column_values(item_id:9876543210, board_id:1234567890, column_values: "{\"connect_boards2\" : {\"item_ids\" : [12345, 23456, 34567]}}") {
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: "{\"connect_boards2\": {\"item_ids\": [9876543210, 1234567890, 0987654321]}}"

You can find the Postman request to change the connect boards column here.

Clearing the connect boards column

You can clear the connect boards column using a change_multiple_column_values mutation like the one below.

mutation {
 change_multiple_column_values(item_id:9876543210, board_id:1234567890, column_values: "{\"connect_boards\" : null}") {

You can also find the Postman request to clear the connect boards column here.


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!