Update a website's maintenance mode

PATCH

https://api.modulards.com/api/public/v1/sites/:site/maintenance

PATCH

/api/public/v1/sites/:site/maintenance

curl -X PATCH https://api.modulards.com/api/public/v1/sites/site/maintenance \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "background": "#1a1a2e",
  "description": "Scheduled maintenance in progress.",
  "noindex": true,
  "status": "enabled",
  "title": "We will be right back"
}'

200Update a website's maintenance mode

{
  "data": {
    "attributes": {
      "connection_status": "established",
      "connector_version": "3.4.2",
      "core_version": "6.6.2",
      "created_at": "2026-01-14T09:30:00.000000Z",
      "created_by": 42,
      "db_engine": "mysql",
      "db_engine_version": "8.0.36",
      "deleted_at": null,
      "display_host": "acme-corp.com",
      "ecommerce_engine": "woocommerce",
      "ecommerce_version": "9.2.3",
      "engine": "php",
      "engine_version": "8.3.10",
      "host": "acme-corp.com",
      "is_connected": true,
      "is_main_site": true,
      "is_multisite": false,
      "locale": "en_US",
      "maintenance_background": "#1a1a2e",
      "maintenance_description": "Scheduled maintenance in progress.",
      "maintenance_noindex": true,
      "maintenance_status": "enabled",
      "maintenance_title": "We will be right back",
      "name": "Acme Corp",
      "path": null,
      "provider": "wp",
      "scheme": "https",
      "slug": "acme-corp",
      "synced_at": "2026-09-16T08:12:00.000000Z",
      "timezone": "Europe/Madrid",
      "updated_at": "2026-09-21T09:35:00.000000Z",
      "uri": "https://acme-corp.com"
    },
    "id": "101",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/sites/101"
    },
    "type": "sites"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Turns a website’s WordPress maintenance mode on or off and customizes the page visitors see while it is on. Send only the fields you want to change.

The change reaches WordPress through the Modular Connector plugin a moment later: the answer confirms the request was stored and queued, not that the website has already switched. While maintenance mode is on the website’s connection status is maintaining; turning it off also re-verifies the connection in the background. Returns the same document as “Retrieve a website’s maintenance mode settings”.

The four customization fields depend on your plan: an organization whose plan does not include them can still change status.

Body

status (enabled or disabled, optional): turns maintenance mode on or off.
noindex (boolean, optional): whether search engines are told not to index the maintenance page.
background (string, optional): a hex color for the page background.
title (string, optional): the page title, at most 70 characters.
description (string, optional): the message shown to visitors, at most 250 characters.

Errors

422: noindex, background, title or description is sent while your plan does not include them.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

sitestringRequired

Request

This endpoint expects an object.

backgroundstringOptional

descriptionstringOptional

noindexbooleanOptional

statusstringOptional

titlestringOptional

Response

200 - Maintenance updated

dataobjectOptional

jsonapiobjectOptional