Connect Boards

The connect boards column links an item on the board with item(s) on different board(s).

Check out our help center to learn more about the connect boards column.

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.

Here is an example payload showing both fields:

  "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.

Code example

mutation {
  change_multiple_column_values(item_id:11111, board_id:22222, 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\": [12345, 23456, 34567]}}"
curl "" \
-H "Content-Type:application/json" \
-H "Authorization:MY_API_KEY" \
-d '{"query":"mutation{change_multiple_column_values(item_id:162169283, board_id:162169280, column_values:\"{\\\"connect_boards2\\\" : {\\\"item_ids\\\" : [12345, 23456, 34567]}}\"){name}}"}'


Do you 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!

Did this page help you?