---
id: workflow-alias-create
title: "Create an alias"
description: "Creates an alias pointing at an existing revision. `latest` is reserved. Creating an alias does not activate its triggers; call the activate endpoint for that."
sidebar_label: "Create an alias"
hide_title: true
hide_table_of_contents: true
api: eJztWG1v2zYQ/isHfsnLFDndOnTQPqVdC3RAtyBN0QJtMNPiyeJCkSpf7HiG//twpGTLsZJuAwZsQP3FtkQe75577nh3a+b53LHiI3tv7G2lzBK4ktyhYzcZE+hKK1svjWYFe2GRe3TAdVoDrZHaSz0H7ukh3kkX/1pcSCeNzmGqaIefgnRg0aFdoMghCor7eknCoANtPPDSywX3CNI78FbO52jdj1BypcDXuHuPWsTjoTIWfM19zjJmWrSctH0tWMGWnUVn8YyijOqzjLXc8gY9WrJ7zSTZ1nJfs4xp3iArmBQsYxY/B2lRsMLbgBlzZY0NZ8Wa+VVLq5y3Us/Z5j5OWyQtVmhRl1gAh2i8PWuk9ihACjieLqvf8jyfnkA0AaFX+MhBqSRqf1bWxqGGW1zBsTJLtCV3CE6FeQZBy88BoUULxs65ln9E008ICLzjTatIyWX1m6zeP5+9r9owP9dsc5MsQ+efG7Eic0qjPWpPP3nbKllGOZPfHVmzPrTbzH7H0u8h9DEhR4+S64k9rSV/eImONido74M3VFXJBRKaWxm71QTaHO1w+Xeb+MmYwzJY6VfRmTPkFu1F8DUrPt4kY11rtEtKfHv+hL72/XVNvIo0XHIHiSaCUPzrwEgfLbggKSx7FKjeya9Fz7eBxRmLBKdnoRWkx4U/hHIg4lFAD3yf/Qte2Kq8WzczRiEna+4FRo2+xsT1CPjRLsaB2110i5w02CEwonBlbMM9KxitOfOywcGW56vRMG3Qc8H9CJc3GesUeespY42xfd+WN7wFU/XqUzx7E5NWZ4M0GhzJIiJxISQ94epyz5E9b64HZ4/QZ9/7JDW4USfq0BDFWtQiPVGJSxWXColvUnfOuun99ncRFviPtinu/EtrjR1Ddt++Bp3j8xGWbigixdgLSgM2aDrszYM+vu/Bq7QBaDW4UNbAXaRm59MjB9Mlzmpjbt9ZNc0PFN29HFPpIa/TZbLpPxl7+uHDYUZ6EbM/IAGWA+WnmRErcHzlYFlzD0t6vbRGz4t489JCmJIK0ww41KHh+swiF3ymEKYCPZeKXmmRgdGw4EqKRFLiRrDo6Dldq96u0p1SVYlGUElUj+XD1pqZwuabh/PiZVoxQu3DTOw814Jb0RkVDT++evUCnv1w/gy6syBZ5LJ0rQpy3fQhnaYnh75Lehyyd1+fyFigNfDu6nUGmM9zmNbet66YTLb1hVs5j00ucDGJSrvdK238WWWCFtP9a/kfyYhpKkH6WAb/xVBV1K0/yBYjSfzp+dMY2QTpl0RvixRYSl9T3rt3y6Qy0NHZUpMzyy+ouzXUTQRWUseYcZORyysBM5DGreWrA69dUqWp/QM8L77Mc+mxGb0C9jkUa8bHTXMeWzdxJdeT0uhKdtfQAwluuLUJzkPNFwh98QDd6Ss4ojR4xAZZ5PuxLPJO412LJZWbqfjsEsrXSP4ayV8j+T8ZyalIrQ21r61xUdOo20PYrqXYTPqOnXohivPU1waqS7b05K3MdVCqVdxTiZaXponNYN8+vaVYT3AMm6itZSSIdV1wLPLjIpZ1P171Zd/P769j9UPxerVrNF/2ePSdYF+b7vqM7yLRKjPMN30vTcaRZYkX5/mT/PyALc+DVCKDNsyUdHUGNuhY8YCZRVy2hHdEKKr0hoDswgH1XGrMP+lP+pUJVNsjd32PjeBr6eDi8nVBC87g9PSnnT9OT2MfM2zmQZgyNKi9y+HlAi2VcQuEGZamoWEK6NDMkFhxetpjcXqagTM0EKmJztIBUvpWxvk8nXmRXN6dR4iKNI6hVsob4NshDBwreYswJbinJzlcdP3JcPwiu7LSB6vd3ugFjO5OfHmHZeiNtFgaSuzRnogzxQfMVvE76zKKboOnujL49IN8oczcdRLfYmmROiYtYMGtpFqVhN8ittSGC9RecpUWOPSksyNpsfGqEXaBEPtFCpiG6wHF0sRqa+d9xgxGH/+D4VYXhx7v/KRVXMZEGlLzkZLEbriQTN3SkmWsiDOtwWyvpvRSfGTr9Yw7fGfVZkOPPwe0NEq5yVjvk5hNhHT0W7Ci4srhI0geX3Vp7gT+A5OwUdT6S0fTlbPgKtA/lrFbXKXp34b64xq5QButTy9eJBvPrmn7buPBbGiT9TsuyhJb/+jam0HKv/z17TVl1G4w18Rul1m+pDzJl0lJ0yafFuv0bM0U1/MQ7yGWZMbucz9930vX0apRGNbrtOLa3KLebLaoePpPwGw2fwJOfcnM
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={"Create an alias"}
>
</Heading>

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



Creates an alias pointing at an existing revision. `latest` is reserved. Creating an alias does not activate its triggers; call the activate endpoint for that.

<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"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","required":["name","revision"],"properties":{"name":{"type":"string","example":"live"},"revision":{"type":"integer","example":3}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"201":{"description":"The alias was created.","content":{"application/json":{"schema":{"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}}}}}}}}},"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>