Skip to content
Skip to Content
Docs
Studio

Archive Recipe

Archive a recipe — take it offline.

Sets the lifecycle marker to ARCHIVED and writes a new Version. Use unarchiveRecipe to reverse. Idempotent: re-archiving an already-archived recipe returns the existing version_id.

POST
/studio/recipes/{recipe_id}/archive

Path Parameters

recipe_id*Recipe Id

Header Parameters

If-Match*string

The recipe's current version_id: the one the last change to this recipe returned, or the one reading the recipe returns (get_recipe). A stale value is refused with the current version_id; read the recipe again and retry.

Response Body

Successful Response

application/json
  1. response

Response for get recipe endpoint.

data*

Recipe with presence summary and computed action permissions.

meta*

Response metadata.

version_id?|

Version committed for this mutation; pass on the next request as If-Match for optimistic concurrency. Present only on versions declaring the recipe_versioning capability.

Example Request
curl -X POST 'https://api.bettermenu.live/studio/recipes/string/archive' \  -H 'If-Match: string'
Example Response
{  "data": {    "id": "string",    "name": "string",    "country": "US",    "regulatory_authority": "US_FDA",    "demographic": "adults_and_children_over_4",    "status": "active",    "created_at": "string",    "updated_at": "string",    "summary": {      "ingredient_count": 0,      "has_nutrition": true,      "is_nutrition_current": true,      "serving_count": 0,      "has_nutrition_facts": true    },    "actions": {      "can_modify": true,      "can_archive": true,      "can_delete": true    }  },  "meta": {    "version": "string",    "request_id": "string",    "timestamp": "string"  },  "version_id": "string"}

Recipe in, FDA-format Nutrition Facts out, with every version kept.

Start freeNo card needed.