DELETE /workflow-definitions/{id}

← Workflows

DELETE

/v1/workflow-definitions/{id}

Delete a workflow definition

Host

https://api.embodiflow.io/v1
https://api.embodiflow.dev/v1

Authentication

Authorization: Bearer PAT

Parameters

Name	In	Type	Required	Description
id	path	string	Yes	Not published in OpenAPI
if-match	header	string	Yes	Not published in OpenAPI
If-Match	header	string	No	Optional precondition. A matching tag proceeds and returns the new ETag. A stale tag returns 412 PRECONDITION_FAILED with no write. Absent proceeds (opt-in this release). If-Match: * succeeds when the resource exists. Malformed values return 400 IF_MATCH_INVALID.

Request body

Not published in OpenAPI

Responses

Status	Description	Content-Type	Schema
204	Success	Not published in OpenAPI	Not published in OpenAPI
400	Bad request. Enumerated catalog codes for this operation.	application/problem+json	union
401	Authentication failed. A specific TOKEN_* cause is returned only when the presented hash matched a stored row.	application/problem+json	union
403	Authorization failed. PERMISSION_DENIED on an any-of route lists the alternatives in message.	application/problem+json	union
404	Not found. Enumerated catalog codes for this operation.	application/problem+json	union
409	Conflict. Enumerated catalog codes for this operation.	application/problem+json	union
412	If-Match did not match the current resource. No partial write.	application/problem+json	union
429	Authenticated per-principal or per-tenant request budget exceeded. Rate-limit headers appear only on 429.	application/problem+json	union

{
  "allOf": [
    {
      "$ref": "#/components/schemas/ProblemJson"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            400
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "BAD_REQUEST",
            "IDEMPOTENCY_KEY_INVALID",
            "IF_MATCH_INVALID",
            "TENANT_CONTEXT_MISMATCH",
            "TENANT_REQUIRED",
            "VALIDATION_ERROR",
            "WORKFLOW_DEFINITION_REVISION_NOT_PUBLISHED"
          ]
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PublishedAuthProblem"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            401
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "TOKEN_MALFORMED",
            "TOKEN_NOT_FOUND",
            "TOKEN_EXPIRED",
            "TOKEN_REVOKED",
            "UNAUTHORIZED",
            "SESSION_EXPIRED",
            "ACTIVATION_REQUIRED",
            "MFA_REQUIRED"
          ]
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PublishedAuthProblem"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            403
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "PERMISSION_DENIED",
            "PERMISSION_NOT_DECLARED",
            "FORBIDDEN",
            "MEMBERSHIP_NOT_FOUND",
            "MEMBERSHIP_DISABLED",
            "MEMBERSHIP_EXPIRED",
            "PROJECT_MEMBERSHIP_EXPIRED"
          ]
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/ProblemJson"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            404
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "NOT_FOUND",
            "USER_NOTIFICATION_NOT_FOUND",
            "WORKFLOW_DEFINITION_NOT_FOUND",
            "WORKFLOW_NOT_FOUND",
            "WORKFLOW_NOT_VISIBLE",
            "WORKFLOW_REVISION_NOT_FOUND"
          ]
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/ProblemJson"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            409
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "IDEMPOTENCY_CONFLICT",
            "WORKFLOW_DEFINITION_CODE_CONFLICT"
          ]
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/ProblemJson"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            412
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "PRECONDITION_FAILED"
          ]
        }
      }
    }
  ]
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PublishedAuthProblem"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "integer",
          "enum": [
            429
          ]
        },
        "code": {
          "type": "string",
          "enum": [
            "RATE_LIMITED"
          ]
        }
      }
    }
  ]
}

Example

curl -X DELETE 'https://api.embodiflow.io/v1/workflow-definitions/{id}' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'