Update site note | Modular DS

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

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

sitestringRequired

Request

This endpoint expects an object.

notestringRequired

Response

Successful response

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