Update Collection - Plugixa Recipe

PUT /plugixa-recipe/v1/collections/{id}

Change the fields you send and leave the rest as they are.

Needs the plugixa_recipe_edit capability, or WordPress’s edit_posts (Contributor and up). Needs Plugixa Recipe Pro with the Collections app on.

Note. status values other than active and inactive are stored as sent, and a collection whose stored status is not published is left out of the public list.

Request

PUT https://your-site.example/wp-json/plugixa-recipe/v1/collections/4

Path parameters

Request body

Content type: application/json

Any field of Create Collection, none of them required. An unknown type keeps the current one. is_public wins over visibility when both are sent.

{
  "status": "inactive"
}

Responses

200 OK. data is the updated collection.

{
  "success": true,
  "message": "",
  "data": {
    "id": "4",
    "name": "Weekday Dinners",
    "slug": "weekday-dinners",
    "description": "Quick dinners for busy evenings.",
    "image_id": null,
    "type": "collection",
    "status": "inactive",
    "is_featured": false,
    "display_order": "0",
    "user_id": "1",
    "visibility": "public",
    "created_at": "2026-11-12 09:30:00",
    "modified_at": "2026-11-12 10:15:00",
    "title": "Weekday Dinners",
    "is_public": true,
    "recipes": [
      {
        "id": "12",
        "title": "Lemon Pancakes",
        "slug": "lemon-pancakes",
        "image_id": "345",
        "prep_time": "10",
        "cook_time": "15",
        "total_time": "25",
        "difficulty": "easy",
        "rating_average": 4.5,
        "status": "published",
        "display_order": "1",
        "day_number": null,
        "meal_type": null,
        "added_at": "2026-11-12 09:40:00",
        "image_url": "https://your-site.example/wp-content/uploads/2026/11/lemon-pancakes-150x150.jpg"
      }
    ],
    "recipe_count": 1
  }
}

Errors

Plus the errors every endpoint can return.

Examples

curl -s -X PUT "https://your-site.example/wp-json/plugixa-recipe/v1/collections/4" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"status":"inactive"}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-recipe/v1/collections/4');
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([
        'status' => 'inactive',
    ]),
]);
$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/collections/4', {
  method: 'PUT',
  headers: {
    'Authorization': auth,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"status": "inactive"}),
});
const { data } = await response.json();