Error "Cannot delete Jira Board with id xxx" when deleting a board from Jira Align via API

Summary

This article addresses an error encountered when attempting to delete a Jira board via API in Jira Align. The error message received is:

Diagnosis

When attempting to delete a Jira board in Jira Align using the API and providing the Jira Board ID, the following error is displayed:

Cause

This issue arises because the ID used in the API call is the Jira Board ID, whereas the API requires the Jira Align Board ID for deletion.

Solution

To resolve this issue, follow these steps to obtain the correct Jira Align Board ID and successfully delete the board:

1. Access the API endpoint to retrieve the mapping between Jira Board IDs and Jira Align Board IDs using a GET on the following:

   1 /align/api/2/Connectors/{connectorId}/boards

   Replace {connectorId} with the appropriate connector ID you are working with.

2. Use a filter with the Jira Board ID to find the corresponding Jira Align Board ID. This can be done using Swagger or a similar API testing tool. For example:

   1 boardid eq 565

   This filter should be applied to match the actual Jira Board ID.

3. In the response body, look for the correct Jira Align Board ID. The response will look something like this:

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 [ { "id": 45, "boardId": 565, "boardName": "Scrum XG Board", "teamId": 437, "teamName": "teamname", "programId": 195, "errorMessage": null, "connectorId": 20, "originSprints": true, "createdBy": null, "createDate": "2024-11-29T00:00:00.000Z", "lastUpdatedDate": null, "lastUpdatedBy": null, "areSprintsEnabled": true } ]

   Here, in this example id: 45 is the Jira Align Board ID you need.

4. Use the correct Jira Align Board ID to make a DELETE request to the following endpoint:

   1 /align/api/2/Connectors/{connectorId}/boards/{id}

   Replace `{connectorId}` with the actual connector ID and `{id}` with the Jira Align Board ID obtained in the previous step.

5. Verify that the board has been successfully deleted by checking in Jira Align Settings > Jira Management>Jira Boards that the referenced Board is no longer available.