Delete a program

Deletes a program from the space. Optionally deletes all associated tasks if specified.
The deletion is performed asynchronously and returns operation IDs for tracking the deletion progress.

Key Features:

  • Removes program and all its metadata
  • Optionally deletes all associated tasks (deleteTasks parameter)
  • Preserves content associations unless explicitly deleted
  • Returns async operation IDs for tracking deletion progress
  • Maintains audit trail of deletion action
  • Removes program from all related queries and views

Authorization Logic:

  1. User must have a valid token with appropriate scopes
  2. User must have program update permissions
  3. User must have permission to delete the specific program

Usage Example:

Delete a completed program to clean up the space, or remove a cancelled program including all its tasks to maintain space organization.

Path Params
string
required
length between 7 and 22

The unique identifier of the space containing the target entity. This determines the scope of entity queries and ensures proper access control. The space must be accessible to the authenticated user with appropriate permissions. It can be the unique identifier (GUID) of the space or the word "default" to indicate the default programs space. Common values include "default" and "rkr83lapKkyCJuLLWqLqzB".

string
required

The unique identifier of the program to delete. Must be a valid program ID within the specified space.

Query Params
boolean
Defaults to false

Optional flag to also delete all associated tasks. If false, tasks will be orphaned (no longer associated with the program).

Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json