Delete Workflow

Archive the Workflow and clear it from the Project default. New Assets cannot select it and new events do not start runs. Accepted actions finish, and outputs and retained history remain available.

DELETE

/workflows/{workflowId}

Authorization

Authorization

header

string

required

Enter the project access token with the Bearer prefix, e.g. "Bearer project_access_token"

Path Parameters

workflowId

string

required

ID of the Workflow.

Responses

Delete Workflow

application/json

error

object

required

status

"error"

string

required

Status indicates the response status "error"

Validation error

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Authentication error

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Forbidden error

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

NotFound error

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Conflict error

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

TooManyRequests error

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

ServiceUnavailable error

import Chunkify from '@chunkify/chunkify';

const client = new Chunkify({
  projectAccessToken: 'My Project Access Token',
});

const result = await client.workflows.delete(
  'wfl_example',
);

console.log(result);
from chunkify import Chunkify

client = Chunkify(
    project_access_token="My Project Access Token",
)

result = client.workflows.delete(
    "wfl_example",
)

print(result)
<?php

use Chunkify\Client;

$client = new Client(
    projectAccessToken: 'My Project Access Token',
);

$result = $client->workflows->delete(
    'wfl_example',
);

var_dump($result);
package main

import (
	"context"

	"github.com/chunkifydev/chunkify-go"
	"github.com/chunkifydev/chunkify-go/option"
)

func main() {
	client := chunkify.NewClient(
		option.WithProjectAccessToken("My Project Access Token"),
	)

	err := client.Workflows.Delete(
		context.TODO(),
		"wfl_example",
	)
	if err != nil {
		panic(err)
	}
}

No content
{
  "error": {
    "code": 400,
    "message": "Invalid request parameters",
    "type": "ValidationError"
  },
  "status": "error"
}
{
  "error": {
    "code": 401,
    "message": "Authentication error: invalid token or subscription inactive",
    "type": "AuthenticationError"
  },
  "status": "error"
}
{
  "error": {
    "code": 403,
    "message": "Unauthorized to perform this action",
    "type": "ForbiddenError"
  },
  "status": "error"
}
{
  "error": {
    "code": 404,
    "message": "Ressource not found",
    "type": "NotFoundError"
  },
  "status": "error"
}
{
  "error": {
    "code": 409,
    "message": "source_unavailable: the original video is no longer accessible",
    "type": "ConflictError"
  },
  "status": "error"
}
{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded",
    "type": "TooManyRequestsError"
  },
  "status": "error"
}
{
  "error": {
    "code": 503,
    "message": "The service is temporarily unavailable; retry the request",
    "type": "ServiceUnavailableError"
  },
  "status": "error"
}

# Delete Workflow > Archive the Workflow and clear it from the Project default. New Assets cannot select it and new events do not start runs. Accepted actions finish, and outputs and retained history remain available. ```json { "path": "/workflows/{workflowId}", "method": "delete", "schema": { "description": "Archive the Workflow and clear it from the Project default. New Assets cannot select it and new events do not start runs. Accepted actions finish, and outputs and retained history remain available.", "operationId": "deleteWorkflow", "parameters": [ { "description": "ID of the Workflow.", "in": "path", "name": "workflowId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Delete Workflow" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorValidation" } } }, "description": "Validation error" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorAuthentication" } } }, "description": "Authentication error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorForbidden" } } }, "description": "Forbidden error" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorNotFound" } } }, "description": "NotFound error" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorConflict" } } }, "description": "Conflict error" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorTooManyRequests" } } }, "description": "TooManyRequests error" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorServiceUnavailable" } } }, "description": "ServiceUnavailable error" } }, "security": [ { "ProjectAccessToken": [] } ], "summary": "Delete Workflow", "tags": [ "Workflows" ], "x-codeSamples": [ { "lang": "typescript", "source": "import Chunkify from '@chunkify/chunkify';\n\nconst client = new Chunkify({\n projectAccessToken: 'My Project Access Token',\n});\n\nconst result = await client.workflows.delete(\n 'wfl_example',\n);\n\nconsole.log(result);" }, { "lang": "python", "source": "from chunkify import Chunkify\n\nclient = Chunkify(\n project_access_token=\"My Project Access Token\",\n)\n\nresult = client.workflows.delete(\n \"wfl_example\",\n)\n\nprint(result)" }, { "lang": "php", "source": "\u003c?php\n\nuse Chunkify\\Client;\n\n$client = new Client(\n projectAccessToken: 'My Project Access Token',\n);\n\n$result = $client-\u003eworkflows-\u003edelete(\n 'wfl_example',\n);\n\nvar_dump($result);" }, { "lang": "golang", "source": "package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/chunkifydev/chunkify-go\"\n\t\"github.com/chunkifydev/chunkify-go/option\"\n)\n\nfunc main() {\n\tclient := chunkify.NewClient(\n\t\toption.WithProjectAccessToken(\"My Project Access Token\"),\n\t)\n\n\terr := client.Workflows.Delete(\n\t\tcontext.TODO(),\n\t\t\"wfl_example\",\n\t)\n\tif err != nil {\n\t\tpanic(err)\n\t}\n}\n" } ] } } ``` ```json #/components/schemas/ResponseErrorConflict { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 409, "description": "Code is the HTTP status code", "examples": [ 409 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "source_unavailable: the original video is no longer accessible" ], "type": "string" }, "type": { "const": "ConflictError", "description": "Type indicates the error category", "enum": [ "ConflictError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorTooManyRequests { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 429, "description": "Code is the HTTP status code", "examples": [ 429 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Rate limit exceeded" ], "type": "string" }, "type": { "const": "TooManyRequestsError", "description": "Type indicates the error category", "enum": [ "TooManyRequestsError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorServiceUnavailable { "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 503, "description": "Code is the HTTP status code", "examples": [ 503 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "The service is temporarily unavailable; retry the request" ], "type": "string" }, "type": { "const": "ServiceUnavailableError", "description": "Type indicates the error category", "enum": [ "ServiceUnavailableError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ] } ``` ```json #/components/schemas/ResponseErrorValidation { "properties": { "error": { "properties": { "code": { "const": 400, "description": "Code is the HTTP status code", "examples": [ 400 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Invalid request parameters" ], "type": "string" }, "type": { "const": "ValidationError", "description": "Type indicates the error category", "enum": [ "ValidationError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ] } ``` ```json #/components/schemas/ResponseErrorAuthentication { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 401, "description": "Code is the HTTP status code", "examples": [ 401 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Authentication error: invalid token or subscription inactive" ], "type": "string" }, "type": { "const": "AuthenticationError", "description": "Type indicates the error category", "enum": [ "AuthenticationError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorForbidden { "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 403, "description": "Code is the HTTP status code", "examples": [ 403 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Unauthorized to perform this action" ], "type": "string" }, "type": { "const": "ForbiddenError", "description": "Type indicates the error category", "enum": [ "ForbiddenError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ] } ``` ```json #/components/schemas/ResponseErrorNotFound { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 404, "description": "Code is the HTTP status code", "examples": [ 404 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Ressource not found" ], "type": "string" }, "type": { "const": "NotFoundError", "description": "Type indicates the error category", "enum": [ "NotFoundError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ```