---
id: workflow-alias-deactivate
title: "Deactivate an alias"
description: "Marks the alias inactive and tears down its running triggers (best effort)."
sidebar_label: "Deactivate an alias"
hide_title: true
hide_table_of_contents: true
api: eJztWN1v3DYS/1cGfPHHyVr3Loce9Oa0CZADemckDlIgNbpccbRiLZEKOdr13kL/+2FISfsl22jahz7EL9ZKQ/I3M7/54laQXHqRfRafrHsoKrsGWWnp0Yv7RCj0udMNaWtEJn6S7sEDlRhFQBuZk14hSKOAUDoPyq4NaPLgWmO0WQI5vVyi83C+QE+ARWEdXaQiEbZBJ3nnd0pkYt2ffhW2zhSGrSWhSEQjnayR0DHOrdCMpZFUikQYWaPIhFYiEQ6/tNqhEhm5FhPh8xJrKbKtoE3DUp6cNkvRHes1au6wQIcmxwwkeHQrdFe1NoQKtILz+br4NU3T+QVYF8wwgD7zkFcaDV3lpfVo4AE3cF7ZNbpcegRftcsEWqO/tAgNOrBuKY3+X1A/GAMfZd1UDHJd/KqLT68Xn4qmXV4b0SWTGgcz/RGl70Y38o4pzCtJ6GkO2oPDoLwKjpUt2ataakNSG1SHaCu9QtHdJ8Jj3jpNm+ChBUqH7qalUmSf7/mzQ99Yw6zKtuLv19f87xTP6HVtDdiWclsjn5dbQ2iIF8mmqXQeJGa/eV65PdXZLn7DnJg5jllGOp4bbcZimgL6m96Ix8t2Rv08EvOdGozP31faM+xExAgQiWgbJQnVDXHcHJ67t8WJX553fe/t5xZFD+xh2kkzc5fo9sX/0Y2Qd3ILayuUrM1RXJRIJbpdxJ/5XTxLhzDEqEoZwc4CE4AL62pJIhMsc0W6xr0lrzeThK2RpJI04dkuET2QD8S0nfL9ce5qwBYDfA5nsiFR7THO817MN6mU5jeyuj1w5MCbu72zJ+hz6H3etfWTTjRtzRRr0Kj4popcKqSukPk2ZFhxP/jt91p4l0h/17JKenrjnHUvR1WN3svlBEs7Dlw19aFjvraGD/vpSR8fe/B9XAAsDb7NS5CxGPU+PfMwX+OitPbho6vm6QnQ3ccpSE95ndNqF/4OjNlTYN+v0jm5YacR1hP+Ptzg2LijPw6VvuVUbAjWJZqRvFxqQ6GNPEnFgO/Vzz+fJtYfQmUC5ANT4DS7sGoDXm48rEtJsA4HOGuWGUgTBWHOuOYJSCjbWporh1LJRYUwV0hSV/zJqASsgZWstIoRxIBah57fI6Aht4n1rigix6HQWKlncnrj7KLC+m8Tub0PvtsoMRF3pwXFkzRKOtUrFRQ/f//2B/j+X9ffQ38WRI18AkPV8zB/CtP84pRYEcdLrgweB5aBj+/fJYDpMoV5SdT4bDYb+x+/8YR1qnA1C6D97pOxdFXY1qj5YRH+qj1CDo0mfa68/McSjPInqWyiwry6fhWIziZ9aeuxgYK1ppKT8lEJBHzUnjyfrQ07M38B7qionykstAkB7WcTlTUaZiJ8pwNwmufZyzw/zgZPZNHQ3T2vmids/Mzn0sxyawrd18gnsu/+0rr1BKVcIQydDfSnb+CMc/RZn0JCFvnnVBb5aPCxwZxb4dgY9wnlWyR/i+RvkfyXjOTYQZeWx+vG+oA0YHvKtlutulk//c+24aGbHUziMfTjGN5yHzUyVjY6NW1VNZUkbinT3NYHg+EHDv9oof3xcFSWNxL9/BqGkiAkkv7h7dCm/vvTXWiltCnsfjIZhnie5xhjdPp1+l16fUKF162uVAJNu6i0LxO+rAjtDNhF0HBks2e2cI+5r9qO62iW2mD6i/nFvLUtTxUo/TDcI1CpPdzcvstY4AouL3/cGfvyMkxQ+7cIoGze1mjIp/BmhY57tBXCAnkM9iDBtPUC2eWXl8O0d3mZgLdgLJXMVe0BOTdX1lMaz7yJ/uzP43lSQWM53J3nGUjCsBecV/oBYc5DyPwihZt+MjJLbgv7K5++Z6TWGR/mp3EgtKY/8c0j5u2gpMPcctYO+gQ7M/lhsQn/kz5dmKYlbhpbig/si8oufb/jB8wd8qxmFKyk09yI8uYPiA3kDhUa0rKKAh6JMXveLYx84WJhMHyYVDkaahmqUn+d8uPI8lHXY9Zsd4XuT74J6yOA8JFmTSV1yGptHFNixO6uISKskUYiEVm4/Bou7RKR7dCPkXufiJIzQPZZbLcL6fGjq7qOX39p0fGlzX0iBsuG6Fba87MSWSErj8/Y4vx9n4ku4C9wkTZpy6EuGK4KK1m1/Esk4gE38fKQL9m+SuM/cov2FVCjazu+DShRKnTBV/HbTZ5jQ3urTq7KOB2PFeH2vx/umDeHWfgo64btJyFtt1Hizj6g6boRIfFvRth1/wcNx9XI
sidebar_class_name: "post api-method"
info_path: docs/api/workflows
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Deactivate an alias"}
>
</Heading>

<MethodEndpoint
  method={"post"}
  path={"/workflows/definitions/{id}/aliases/{alias}/deactivate"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Marks the alias inactive and tears down its running triggers (best effort).

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"id","required":true,"schema":{"type":"string"},"description":"Workflow reference: a server-minted id (`wf_...`) or the workflow's client-chosen key (lowercase slug, unique per organization).","example":"wf_ifWBbWfpug0n"},{"in":"path","name":"alias","required":true,"schema":{"type":"string"},"description":"The alias name. `latest` is reserved and auto-maintained.","example":"live"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The deactivation outcome.","content":{"application/json":{"schema":{"type":"object","properties":{"alias":{"title":"Alias","type":"object","required":["workflowId","name","revision","active","updatedAt"],"properties":{"workflowId":{"type":"string","example":"wf_ifWBbWfpug0n"},"name":{"type":"string","example":"live"},"revision":{"type":"integer","example":3},"active":{"type":"boolean","description":"Whether the alias's triggers are activated."},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"},"metadata":{"type":"object"},"triggerStates":{"type":"object","description":"Map of trigger id to its activation state.","additionalProperties":{"title":"TriggerState","type":"object","properties":{"status":{"type":"string","enum":["pending","live","failed","inactive"]},"activatedAt":{"type":"string","format":"date-time"},"deactivatedAt":{"type":"string","format":"date-time"},"lastError":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"}}},"runtimeMetadata":{"type":"object","description":"Runtime data such as the trigger's `webhookUrl`.","properties":{"webhookUrl":{"type":"string"}},"additionalProperties":true}}}}}},"deactivatedTriggers":{"type":"array","items":{"type":"string"}},"deactivateError":{"type":"string","description":"Present when trigger teardown failed."}}}}}},"4XX":{"description":"Client error. The body says what went wrong: an error `type`, a human-readable `detail`, and, on validation failures, one entry per offending field.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}},"5XX":{"description":"Unexpected server error.","content":{"application/problem+json":{"schema":{"title":"Problem","type":"object","description":"The standard error body (RFC 7807 problem details, served as `application/problem+json`).","properties":{"type":{"type":"string","description":"Error type URI, e.g. `https://workflow-system.dev/errors/workflow-not-found`.","example":"https://workflow-system.dev/errors/workflow-not-found"},"title":{"type":"string","example":"Not found"},"status":{"type":"integer","example":404},"detail":{"type":"string","example":"No workflow with id wf_ifWBbWfpug0n exists"},"instance":{"type":"string","example":"/workflows/definitions/wf_ifWBbWfpug0n"},"errors":{"type":"array","description":"Present on validation failures: one entry per offending field.","items":{"type":"object","properties":{"path":{"type":"string","example":"/steps/scan/config"},"message":{"type":"string","example":"must have required property 'code'"}}}}}}}}}}}
>
  
</StatusCodes>