Contents
On this page

Create Booking Form - Plugixa Car Wash

POST /plugixa-carwash/v1/booking-forms

Create a booking form.

Needs the plugixa_carwash_create capability.

Request

POST https://your-site.example/wp-json/plugixa-carwash/v1/booking-forms

Request body

Content type: application/json

Field Type Required Description
name string Yes At most 190 characters.
layout string No multi or single. Defaults to multi.
display string No packages (packages only), packages_addons (packages, then extras) or services (services only). Defaults to packages_addons.
location_ids array No Limit the form to these locations. Defaults to [], every location.
vehicle_type_ids array No Limit it to these vehicle types. Defaults to [].
package_ids array No Limit it to these packages. Defaults to [].
primary_color string No A hex colour. Defaults to #0EA5E9.
show_summary boolean No Show the live price summary. Defaults to true.
auto_scroll boolean No Scroll to the next section after a choice. Defaults to true.
fields array No Customer fields, each {"key", "enabled", "required"}. Keys: first_name, last_name, email, phone, company, vehicle_make, vehicle_plate, address, message. Unknown keys are dropped, missing ones are added with their defaults, email is always required, and a required field is always enabled. Defaults to the nine fields with their defaults.
agreements array No Each {"text": "...", "required": true}. text may hold simple HTML such as a link. required defaults to true. Defaults to [].
success_message string No Shown after a booking. Defaults to empty.
status string No published or unpublished. Defaults to published. 
{
  "name": "Main booking form",
  "display": "packages_addons",
  "agreements": [
    {
      "text": "I accept the <a href=\"/terms\">terms of service</a>.",
      "required": true
    }
  ]
}

Responses

201 Created. data is the new booking form.

{
  "success": true,
  "data": {
    "id": 1,
    "name": "Main booking form",
    "layout": "multi",
    "display": "packages_addons",
    "location_ids": [],
    "vehicle_type_ids": [],
    "package_ids": [],
    "primary_color": "#0EA5E9",
    "show_summary": true,
    "auto_scroll": true,
    "fields": [
      {
        "key": "first_name",
        "enabled": true,
        "required": true
      },
      {
        "key": "last_name",
        "enabled": true,
        "required": true
      },
      {
        "key": "email",
        "enabled": true,
        "required": true
      },
      {
        "key": "phone",
        "enabled": true,
        "required": true
      },
      {
        "key": "company",
        "enabled": false,
        "required": false
      },
      {
        "key": "vehicle_make",
        "enabled": true,
        "required": false
      },
      {
        "key": "vehicle_plate",
        "enabled": false,
        "required": false
      },
      {
        "key": "address",
        "enabled": false,
        "required": false
      },
      {
        "key": "message",
        "enabled": true,
        "required": false
      }
    ],
    "agreements": [
      {
        "text": "I accept the terms of service.",
        "required": true
      }
    ],
    "success_message": "",
    "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,
    "shortcode": "[plugixa_carwash_booking form=\"1\"]"
  }
}
Field Type Meaning
data.id integer The form’s id
data.layout string multi (steps) or single (one page)
data.display string packages, packages_addons or services
data.location_ids array Locations it offers. Empty means every published one
data.vehicle_type_ids array Vehicle types it offers. Empty means every one
data.package_ids array Packages it offers. Empty means every one
data.fields array The customer fields: key, enabled, required
data.agreements array Boxes to tick: text (HTML) and required
data.status string Only a published form takes bookings
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
data.shortcode string The shortcode that shows it

Errors

Status Code When
422 plugixa_carwash_missing_name name is missing or empty.
422 plugixa_carwash_too_long_name name is longer than 190 characters.
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_empty_agreement An agreement has no text.

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-carwash/v1/booking-forms" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"name":"Main booking form","display":"packages_addons","agreements":[{"text":"I accept the <a href=\"/terms\">terms of service</a>.","required":true}]}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/booking-forms');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'name'       => 'Main booking form',
        'display'    => 'packages_addons',
        'agreements' => [
            [
                'text'     => 'I accept the <a href="/terms">terms of service</a>.',
                'required' => true,
            ],
        ],
    ]),
]);
$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/booking-forms', {
  method: 'POST',
  headers: {
    'Authorization': `Basic ${auth}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'Main booking form',
    display: 'packages_addons',
    agreements: [
      {
        text: 'I accept the <a href="/terms">terms of service</a>.',
        required: true,
      },
    ],
  }),
});
const { data } = await response.json();

Quick Links

Share