Contents
On this page

Update Shopping List - Plugixa Recipe

PUT /plugixa-recipe/v1/shopping-lists/{id}

Change the name or status of a list. Its lines are changed with the item routes.

Needs the plugixa_recipe_edit capability, or WordPress’s edit_posts (Contributor and up). Needs Plugixa Recipe Pro with the Shopping Lists app on. Each user only ever sees and changes their own lists: another user’s list answers 404.

Request

PUT https://your-site.example/wp-json/plugixa-recipe/v1/shopping-lists/9

Path parameters

Name Type Description
id integer The shopping list’s id

Request body

Content type: application/json

Field Type Required Description
name string No New name.
status string No Stored as sent, such as active or done.

modified_at is set even when nothing else changes.

{
  "name": "Sunday shop"
}

Responses

200 OK. data is the updated list with its items.

{
  "success": true,
  "message": "",
  "data": {
    "id": "9",
    "user_id": "1",
    "name": "Sunday shop",
    "status": "active",
    "created_at": "2026-11-12 09:30:00",
    "modified_at": "2026-11-12 10:15:00",
    "items": [
      {
        "id": "55",
        "shopping_list_id": "9",
        "recipe_id": "12",
        "ingredient_name": "flour",
        "quantity": "2",
        "unit": "cups",
        "is_checked": false,
        "sort_order": "0",
        "added_at": "2026-11-12 09:30:00"
      },
      {
        "id": "56",
        "shopping_list_id": "9",
        "recipe_id": "12",
        "ingredient_name": "milk",
        "quantity": "1 1/2",
        "unit": "cups",
        "is_checked": false,
        "sort_order": "1",
        "added_at": "2026-11-12 09:30:00"
      }
    ]
  }
}
Field Type Meaning
data.id string The list’s id
data.user_id string The owner: always the caller
data.status string active unless you set something else; personal marks the list the front end keeps

Errors

Status Code When
404 rest_error No shopping list with that id belonging to the caller.

Plus the errors every endpoint can return.

Examples

curl -s -X PUT "https://your-site.example/wp-json/plugixa-recipe/v1/shopping-lists/9" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"name":"Sunday shop"}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-recipe/v1/shopping-lists/9');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'name' => 'Sunday shop',
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`);
const response = await fetch('https://your-site.example/wp-json/plugixa-recipe/v1/shopping-lists/9', {
  method: 'PUT',
  headers: {
    'Authorization': auth,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"name": "Sunday shop"}),
});
const { data } = await response.json();

Quick Links

Share