> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fire.rest/llms.txt
> Use this file to discover all available pages before exploring further.

# Archive recipe

> Archives a recipe. BOH stops using it for consumption after archiving.

<ParamField header="x-api-key" type="string" required>
  BOH API key with `recipes:write` scope.
</ParamField>

<ParamField path="vendorId" type="string" required>
  Vendor UUID.
</ParamField>

<ParamField path="recipeId" type="string" required>
  Recipe UUID.
</ParamField>

<ParamField body="external_user_id" type="string">
  Actor for audit trail.
</ParamField>

<ResponseField name="ok" type="boolean">
  `true` on success.
</ResponseField>

<RequestExample>
  ```json theme={null}
  {
    "external_user_id": "user_chef_99"
  }
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "ok": true
  }
  ```

  ```json 404 theme={null}
  {
    "error": {
      "kind": "recipe_not_found",
      "message": "Recipe not found"
    }
  }
  ```
</ResponseExample>