Using the REST API to set a board description
How can you use the REST API to set a board description? We have a tool that will automate the creation of categories and boards. We can set the board ID and title, but I don't see how we can set board description either at create time or after the fact. What API call can I use to do this? Thanks.
The description for a board is stored in a setting named "board.description". You can use the "settings" method of the "Board" class to get back a "Settings" object that has methods available for getting and setting settings.
For example, to get the board description for a board named "adminboard":
/restapi/vc/boards/id/adminboard/settings/name/board.description
To set the description:
/restapi/vc/boards/id/adminboard/settings/name/board.description/set?value=Board Description Here
You'll want to properly URL-encode your value, and you'll need to use HTTP POST to execute the set method.
Regards,
Adam
Unfortunately you do indeed have to wait until the board has been created; you can't include it as part of the board creation call. If you wanted to bundle them together and even populate additional settings, a custom endpoint might be a good option.
