---
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/isHfkmCKXK6deigfUqDFsiAdkGaIAWCoD6LJ4uNRKokZccz/N+HIyW/xEq6FRjQAfUX2+SRvHvuueMdl8Lj1InsVtwYe19UZg5YKXTkxF0iJLncqsYro0UmziyhJweooww0Rmmv9BTQ8yA9KBf+Wpopp4xOYVzxCj8G5cCSIzsjmULYKKzrd5KGHGjjAXOvZugJlHfgrZpOybrfIceqAl/SZp60DMdDYSz4En0qEmEassjankuRiXln0XE4I8uD+iIRDVqsyZNlu5dCsW0N+lIkQmNNIhNKikRY+tIqS1Jk3raUCJeXVKPIlsIvGpZy3io9FavHOK2RtFSQJZ1TBgjBeHtcK+1JgpJwOJ4Xn9I0HR9BMIGgV/jAQV4p0v44L40jDfe0gMPKzMnm6Ahc1U4TaLX60hI0ZMHYKWr1VzD9iIGgB6ybipWcF59UcfN6clM07fREi9VdtIycf23kgs3JjfakPf/EpqlUHvYZfXZszXLfbjP5TLnfQeg2IsdD0fXMnsayP7wix4sjtI/B21a1UjNiNNd7bKQZtCnZbfFfVuGTCEd5a5VfBGdOCC3Z09aXIru9i8a6xmgXlfj55AV/7frrinkVaDhHB5EmklH858AoHyw45V1E8ixQvZPPZc+3LYsTEQjOY20jWY9Tvw/l1hbPArrn++Q/8MJa5Y3cxJiKkK15FBgl+ZIi1wPgB5sYB7Sb6JYpa7BBYEDhwtgavcgEyxx7VdPWkteLwTCtyaNEP8DlVSI6RT54zlhDbN+15R02YIpefY5nb0LS6mxQRoPjvZhIKKXiEawudhzZ8+Zq6+wB+ux6n3dt3aATdVszxRrSMo5UkUsFqoqYb0p3zrrr/fZvEZb0TcsqdP6NtcYOIbtrX03O4XSApSuOSDk0wWnAtpoPe/ekjx978DIuAJYG1+YloAvU7Hx64GA8p0lpzP21rcbpnqKbySGVnvI6Xyar/pOIlx8/7meks5D9gRiwFDg/TYxcgMOFg3mJHuY8PbdGT7Nw87IgjFmFcQIIZVujPraEEicVwViSR1XxlJYJGA0zrJSMJGVutJYcj/O16u0i3ilFEWkEhaLquXzYWDOpqP7p6bx4ESUGqL2fiZ1HLdHKzqhg+OHl2zN49dvJK+jOgmiRS+K1Ktl146d0Gh/t+y7qsc/eXX0CY4Fl4PryPAFKpymMS+8bl41G6/rCLZynOpU0GwWl3WZKG39cmFbL8e61/E17hDQVIX0ug783XBV18nvZYiCJvzx5GSKbIf3a1usiBebKl5z3Ht0ysQx0fLbS7Mz8K+quDXUjSYXSIWbcaODyisBs7YbW4mLPaxdcaWr/BM+zr/NceaoHr4BdDoWa8XnTnKfGjVyOepQbXajuGnoiwW0vrVvnocQZQV88QHf6Ag44DR6IrSzy61AWudb00FDO5WYsPruE8iOSf0Tyj0j+LiM5Fqml4fa1MS5oGnR7CtulkqtR37FzL8RxHvvaluuSNT2xUaluq6qp0HOJluamDs1g3z594FiPcGw3UWvLeCPRdcGhyA9CIul+vO3Lvj9urkL1w/F6uWk03/R49J1gX5tu+oxfAtEKwzJsReTAi/QkPRHrcBHvt4yA04tz9gNDVaPe2jy+VawfGB4za6vp/R88a3Qe8PTgR02FKoRQG8vOSI9NWxlNXRNEJCILrxlbrzolEyu7FcvlBB1d22q14uEvLVluou8SMUOruHIMPJLK8W8psgIrR88geXjZEfwIvoM3kEHU+nSjOdnMsGr5n0jEPS3iu8+KO6OSUJIN1seJs2jj8RUv3yzcexVYJf2K0zynxj8re7cV7Bd/frjiWOqeZOrQ5wiLc44QnEclTRN9mi3j2FJUqKdtyEAi7hn6jt3AfRSowapBGJbLKHFl7kmvVmtUPP9nYFarvwFEZxEI
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-create'
---
<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>