Contents
On this page

Update Gift Card - Plugixa Car Wash

PUT /plugixa-carwash/v1/gift-cards/{id}

Change some or all of a gift card’s fields. PATCH does the same as PUT.

Needs Plugixa Car Wash Pro with the Gift cards app on, and the plugixa_carwash_edit capability.

Only what you send changes. A field you leave out keeps its value, so you can send a single field. A field you send is checked exactly as on create.

Request

PUT https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards/11

Path parameters

Name Type Description
id integer The gift card’s id

Request body

Content type: application/json

Field Type Required Description
initial_value number No 0.01 to 100000. The card opens with this balance.
code string No Anything but letters and digits is removed and the rest upper-cased; 6 to 40 characters must remain. Unique.
currency string No Three letters.
recipient_name string No At most 190 characters.
recipient_email string No A valid address when given.
purchaser_name string No At most 190 characters.
message string No At most 1000 characters.
expires_on string No Y-m-d. Anything else is stored as no date.
status string No published or unpublished.
modified_at string No The modified_at you last read. When the gift card has changed since, the update is refused with 409.

code, initial_value and currency cannot be changed: they are ignored here.

{
  "expires_on": "2028-11-12",
  "modified_at": "2026-11-12 09:30:00"
}

Responses

200 OK. data is the updated gift card.

{
  "success": true,
  "data": {
    "id": 11,
    "code": "K7PQ2DW3HN9C",
    "initial_value": 50.0,
    "balance": 35.5,
    "currency": "USD",
    "recipient_name": "Mia",
    "recipient_email": "mia@example.com",
    "purchaser_name": "Lucas",
    "message": "Happy birthday!",
    "expires_on": "2027-11-12",
    "status": "published",
    "created_by": 1,
    "modified_by": 1,
    "created_at": "2026-11-10 08:15:00",
    "modified_at": "2026-11-12 09:30:00",
    "deleted_at": null
  }
}
Field Type Meaning
data.id integer The gift card’s id
data.code string Upper-case letters and digits
data.initial_value number Its value when issued
data.balance number What is left on it
data.currency string It can only pay for bookings in this currency
data.expires_on string|null Last day it can be used, Y-m-d
data.created_at string UTC datetime
data.modified_at string UTC datetime of the last change. Send it back on an update to be warned about a conflicting edit
data.deleted_at string|null null unless the record is in the trash

Errors

Status Code When
404 plugixa_carwash_not_found No gift card with that id, or it is in the trash.
422 plugixa_carwash_too_long_{field} A text field is too long. The code names the field.
422 plugixa_carwash_invalid_{field} A choice field has a value that is not one of its choices. The code names the field.
422 plugixa_carwash_invalid_recipient_email recipient_email is not a valid address.
409 plugixa_carwash_conflict You sent modified_at and somebody saved the gift card since. data.expected and data.current hold both values.

Plus the errors every endpoint can return.

Examples

curl -s -X PUT "https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards/11" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"expires_on":"2028-11-12","modified_at":"2026-11-12 09:30:00"}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards/11');
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([
        'expires_on'  => '2028-11-12',
        'modified_at' => '2026-11-12 09:30:00',
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = Buffer.from(`admin:${process.env.WP_APP_PASSWORD}`).toString('base64');
const response = await fetch('https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards/11', {
  method: 'PUT',
  headers: {
    'Authorization': `Basic ${auth}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ expires_on: '2028-11-12', modified_at: '2026-11-12 09:30:00' }),
});
const { data } = await response.json();

Quick Links

Share