Update site note

PATCH

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

PATCH

/api/public/v1/sites/:site/notes

curl -X PATCH https://api.modulards.com/api/public/v1/sites/site/notes \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "note": "<p>Client prefers deployments on Tuesdays. Staging lives at staging.example.com.</p>"
}'

200Update site note

{
  "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",
      "name": "Acme Corp",
      "note": "<p>Client prefers deployments on Tuesdays. Staging lives at staging.example.com.</p>",
      "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:40: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"
  }
}

Writes the site’s private note — free-form HTML up to 1000 characters, sanitized server-side (scripts and unsafe markup are stripped) and encrypted at rest. Send note: null to clear it.

Answers 200 with the sites resource extended with the note attribute — the only endpoint that exposes it: the note never appears on Show site / List sites.

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

Writes the site's private note — free-form HTML up to 1000 characters, sanitized server-side (scripts and unsafe markup are stripped) and encrypted at rest. Send `note: null` to clear it. Answers 200 with the `sites` resource extended with the `note` attribute — the only endpoint that exposes it: the note never appears on `Show site` / `List sites`. Read-only tokens answer 403; sites of other organizations answer 404. The MCP twin of this endpoint is the `sites-notes-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.

notestringOptional

Response

200 - Note updated

dataobjectOptional

jsonapiobjectOptional