---
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: >-
  eJztWN9v2zYQ/lcOfEmKKXa2deigt7RbgQzoFqQJUiAI6rN4sthIpEpSdjxD//twpCz/UhK03UMfmpfI0pH87r7vjkeuhMeZE+mtuDH2Pi/NArBU6MiJu0RIcplVtVdGi1S8Q3vvwBcUTUBpzLyaE6CW4AmtA2kWGpR3YButlZ6Bt2o2I+vgeErOA+W5sf7FSCTC1GSRZz6XIhWLbvWTMHUqKUyNnkQiarRYkSfLOFdCMZYafSESobEikQolRSIsfW6UJSlSbxtKhMsKqlCkK+GXNVs5b5WeiXbfr95zSzlZ0hmlgODIzsmeVEp7kqAkHE8W+cfRaDR5AcaGMKxBHznISkXan2SFcaThnpZwXJoF2QwdgSubWQKNVp8bgposGDtDrf4N7odg0ANWdckgF/lHld+8nt7kdTM71aJNBj0OYfoWp696GnnGEUxK9OT8BJQDS8F5GYjFxpuTCpX2qDTJXbSlmpNo7xLhKGus8svA0JTQkj1rfCHS2zv+bMnVRrOq0pX45fSU/x3i6VlXRoNpfGYq4vUyoz1pz4OwrkuVBYvxJ8cjV4c+m+knyjwrx7LKvIrrxpixmfIB/VkXxP1hm6De9sI8l+vg8/e5cgw7ETEDRCKaWqIneeY5b3bX3ZrigJenqe/YfmpQZGAL08aalTsju23+a9tD3thNjSkJ2Zu9vCjIF2Q3GX/kNvmMlmCdo3LECDYRGACcG1uhF6lgmxOvKtoa8no5KNiKPEr0A8y2ieiAvPcs2yHu92tXDSZfw+d09iYUqi3FOZ6L9YZSKn6D5cUOkWvdXG2tPSCfXfZ51sYNkqibiiVWk5bxTRm1lKMqifW2rrDibs3bl0Z4U0i/aFiJzv9prbHPZ1VFzuFsQKUtJ64c+tCyXhvNi717lON9Bi/jAGBrcE1WAMbNqOP0yMFkQdPCmPtrW05GB0A3H4cgPcY6l9U2/O0Es5PANq9oLS6ZNE/VAN+7E+wHt+dj1+kLLsXaw6Ig3YuXt9qw0UadjMQa38sPHw4L65uwMwHxgiPgMjs1cgkOlw4WBXpYhAWs0bMUUEdDmDCuSQIIRVOhPrGEEqclwUSSR1XyJy0TMBrmWCoZM4gBNZYcvycg7e0y7nd5HjUOuaJSPlHTa2umJVU/DdT2LvkuosVA3h1uKM6jlmhl51Rw/Pjy7Rt49fvpK+jWguiRS2C96zmYPIZp8uJQWBHHc1QGxoFt4PryPAEazUYwKbyvXToe9/2PWzpP1UjSfBxAu80nbfxJbhotJ7ub8FfNEWpoDOlT28vfxkNvf1DKBnaYl6cvg9A5pM9N3TdQsFC+4KK8twUCPSjnHa+tNJOZPQO3d9SNJeVKh4R244GdNQZmIH2HE3BY5+nzOt+vBo9U0dDdPe2a81S7sctQjzOjc9XtkY9U3+2hVeM8FDgnWHc20K2+hCOu0UddCQlV5LehKnKt6aGmjFvh2Bh3BeVHJv/I5B+Z/F1mcuygC8PH69q4gDRgeyy2KyXbcXf6H6/CQzveOYnH1I/H8Ib7qF6xWKuRbsqyLtFzSznKTLVzMHzP6R8jtH087J3liUR3fg2HkmAkku7h7bpN/evmKrRSSueGhzOeSPDPo9PRqehzQfy9BQfOLs45yByHCkM96g7Sf/T+cfOzPlbvSGe1KXH/8x1I57unBz+uS1RBz01sUCNXmwNohNWzJRKRhmuP9XVNItIN+p6zu0QUzH16K1arKTq6tmXb8uvPDVk+rt8lYo5WcXMXeJXK8bMUaY6loydicXzZafAFfAdXKIOxXFcEzfVgjmXDv0Qi7mkZr434euWrPP6W+5OvgBqpbfkcWBBKsoGr+O0sy6j2W6MOLkk4EftacPHP+yvWzW7+7eVbmH4Q0moVLa7MPem27RF6/s0I2/Y/4X0dBA==
sidebar_class_name: post api-method
info_path: docs/api/nullplatform-api
custom_edit_url: null
canonical: 'https://docs.nullplatform.com/docs/api/workflow-alias-deactivate'
---
<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>