PUT Toggle Favorite Venue

​

Adds or removes a store from the customer's favorites and returns the resulting list.

This is a toggle, not an idempotent set — calling it twice with the same store adds it and then removes it again. Drive it from the resulting list rather than from what you expected to happen.

Some brands allow only one favorite store. On those, favoriting a store silently drops the others, so always render the returned list rather than assuming your local state.

The store must belong to the same brand as the calling application.

Path Parameters

  • Venue ID

Headers

  • Type of content accepted by the API (application/json in most cases)

  • Application key for specific client app

  • Content-Type header

  • Version of the API to be used

  • Authorization header

  • Unique request identifier

Body

application/json

No request body.

Responses

  • application/json
  • Favorite stores are not enabled for this brand, or the store belongs to another brand.

  • Missing or invalid customer token.

  • Unknown store.

Request Example for put/customer-accounts/favorite-venues/{venue_id}
curl 'https://api-public-demo.menu.app/api/customer-accounts/favorite-venues/{venue_id}' \
  --request PUT \
  --header 'Accept: application/json' \
  --header 'Application: application-key' \
  --header 'Content-Type: application/json' \
  --header 'API-VERSION: ' \
  --header 'X-Request-ID: c10b4a70-6274-490d-80a0-03e7bb826937'
{
  "status": "OK",
  "code": 200,
  "data": {
    "favorite_venues": [
      {
        "id": 3540,
        "uuid": "4fac4dfc-3d0e-4b9f-8081-8448be89013b",
        "name": "South Corona",
        "brand_id": 57,
        "city": "Corona"
      }
    ]
  }
}