Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Delete workspace

DELETE /api/v1/workspaces/{targetWorkspaceId}

Permanently delete one exact workspace owned by the authenticated personal-token user. Requires confirm=true. This cannot be undone.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

targetWorkspaceIdrequired

string

Exact workspace to delete. This is never replaced by the workspace selected for authentication.

confirmrequired

boolean

No description.

Example

REST requestbash

curl -X DELETE "https://app.pipeline.help/api/v1/workspaces/00000000-0000-4000-8000-000000000000?confirm=true" \
  -H "Authorization: Bearer $PIPELINE_API_KEY"

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.