Update site maintenance | Modular DS

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": "on",
  "title": "We will be right back"
}'

{
  "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": "on",
      "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 the site’s WordPress maintenance mode on or off and updates its customization. All fields are optional (sometimes): status (on / off), noindex (boolean), background (hex color), title (max 70) and description (max 250).

The four customization fields are plan-gated: an organization without the maintenance permission in its plan may still toggle status, but sending any customization field answers 422.

Answers 200 with the same extended sites document as Show site maintenance, reflecting the stored settings. The change is propagated to WordPress asynchronously through the connector — the response confirms the request was stored and queued, not that the site already switched. Disabling maintenance also re-verifies the site connection in the background.

Read-only tokens answer 403; sites of other organizations answer 404. The MCP twin of this endpoint is the sites-maintenance-update tool.

Turns the site's WordPress maintenance mode on or off and updates its customization. All fields are optional (`sometimes`): `status` (`on` / `off`), `noindex` (boolean), `background` (hex color), `title` (max 70) and `description` (max 250). The four customization fields are plan-gated: an organization without the maintenance permission in its plan may still toggle `status`, but sending any customization field answers 422. Answers 200 with the same extended `sites` document as `Show site maintenance`, reflecting the stored settings. The change is propagated to WordPress asynchronously through the connector — the response confirms the request was stored and queued, not that the site already switched. Disabling maintenance also re-verifies the site connection in the background. Read-only tokens answer 403; sites of other organizations answer 404. The MCP twin of this endpoint is the `sites-maintenance-update` tool.

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

The four customization fields are plan-gated: an organization without the maintenance permission in its plan may still toggle status, but sending any customization field answers 422.

Read-only tokens answer 403; sites of other organizations answer 404. The MCP twin of this endpoint is the sites-maintenance-update tool.