Workflows

Archive Workflow Variant

Changed on

Archive a workflow variant.

Soft-deletes the variant and its revisions. Archived variants are hidden from queries unless include_archived=true. See Versioning.

post/workflows/variants/{workflow_variant_id}/archive

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/workflows/variants/{workflow_variant_id}/archive
  • Auth
    API key in header Authorization

Path parameters

workflow_variant_idstring uuid required

Response

Successful Response

countinteger

1 when a variant is returned, 0 when none matched.

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status