Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Actions45

Team → Delete

AI-generated

Overview

This node interacts with the Workboard API to perform various operations on the 'Team' resource, specifically including the ability to delete a team. It is useful for automating team management tasks such as creating, updating, retrieving, and deleting teams within the Workboard platform. For example, a user can delete a team by specifying its Team ID, which helps in maintaining an up-to-date organizational structure.

Use Case Examples

  1. Deleting a team by providing its Team ID to remove it from the Workboard system.
  2. Retrieving details of a specific team or updating team information.

Properties

Name Meaning
Team ID The unique identifier of the team to be deleted or otherwise managed.
Additional Fields Optional fields that can be provided for extended information or metadata when creating, updating, or deleting a team. These include activity descriptions, notes, text formatting options, ownership, workstream, due dates, state, priority, ratings, effort, tags, and comments.

Output

JSON

  • success - Indicates whether the delete operation was successful.
  • error - Error message if the operation failed.
  • resource - The resource type involved in the operation, e.g., 'team'.
  • operation - The operation performed, e.g., 'delete'.
  • itemIndex - Index of the item in the input data array when an error occurs.

Dependencies

  • Workboard API with JWT Bearer Token authentication

Troubleshooting

  • Ensure the provided Team ID is correct and exists in the Workboard system to avoid errors.
  • Check that the API credentials (JWT Bearer Token) are valid and have the necessary permissions to delete teams.
  • If the node throws an error, verify the network connectivity to the Workboard API endpoint.
  • The node may return an error if the team is linked to other resources that prevent deletion; check for dependencies before deleting.

Links

Discussion