> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api.docs.modulards.com/modular-ds-public-api/websites/manage-websites/update-a-website-s-note/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.docs.modulards.com/_mcp/server.

# Update a website's note

PATCH https://api.modulards.com/api/public/v1/sites/{site}/notes
Content-Type: application/json

Sets the private note of a website: free-form text for your own reference, such as who to contact or how the website is deployed. Returns the website with its `note`.

**Body**
- `note` (string or `null`, optional): HTML with up to 1000 characters of text; tags do not count. Scripts and unsafe markup are removed, and the note is stored encrypted. Send `null`, or omit the field, to clear the note.

Reference: https://api.docs.modulards.com/modular-ds-public-api/websites/manage-websites/update-a-website-s-note

## Authentication

- `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

## Request

### Path parameters

- `site` (string, required)

### Body (application/json)

This endpoint expects an object.

- `note` (string, optional)

## Response

### 200

200 - Note updated

- `data` (ApiPublicV1SitesSiteNotesPatchResponsesContentApplicationJsonSchemaData, optional)
- `jsonapi` (ApiPublicV1SitesSiteNotesPatchResponsesContentApplicationJsonSchemaJsonapi, optional)

## Types

### ApiPublicV1SitesSiteNotesPatchResponsesContentApplicationJsonSchemaData

- `attributes` (ApiPublicV1SitesSiteNotesPatchResponsesContentApplicationJsonSchemaDataAttributes, optional)
- `id` (string, optional)
- `links` (ApiPublicV1SitesSiteNotesPatchResponsesContentApplicationJsonSchemaDataLinks, optional)
- `type` (string, optional)

### ApiPublicV1SitesSiteNotesPatchResponsesContentApplicationJsonSchemaJsonapi

- `version` (string, optional)

### ApiPublicV1SitesSiteNotesPatchResponsesContentApplicationJsonSchemaDataAttributes

- `connection_status` (string, optional)
- `connector_version` (string, optional)
- `core_version` (string, optional)
- `created_at` (string, optional)
- `created_by` (double, optional)
- `db_engine` (string, optional)
- `db_engine_version` (string, optional)
- `deleted_at` (any, optional, nullable)
- `display_host` (string, optional)
- `ecommerce_engine` (string, optional)
- `ecommerce_version` (string, optional)
- `engine` (string, optional)
- `engine_version` (string, optional)
- `host` (string, optional)
- `is_connected` (boolean, optional)
- `is_main_site` (boolean, optional)
- `is_multisite` (boolean, optional)
- `locale` (string, optional)
- `name` (string, optional)
- `note` (string, optional)
- `path` (any, optional, nullable)
- `provider` (string, optional)
- `scheme` (string, optional)
- `slug` (string, optional)
- `synced_at` (string, optional)
- `timezone` (string, optional)
- `updated_at` (string, optional)
- `uri` (string, optional)

### ApiPublicV1SitesSiteNotesPatchResponsesContentApplicationJsonSchemaDataLinks

- `self` (string, optional)

## Examples

### 200 - Note updated

**Response**

```json
{
  "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"
  }
}
```

**SDK Code**

```python 200 - Note updated
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.patch(url, headers=headers)

print(response.json())
```

```javascript 200 - Note updated
const url = 'https://api.modulards.com/api/public/v1/sites/site/notes';
const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go 200 - Note updated
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("PATCH", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby 200 - Note updated
require 'uri'
require 'net/http'

url = URI("https://api.modulards.com/api/public/v1/sites/site/notes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java 200 - Note updated
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.modulards.com/api/public/v1/sites/site/notes")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 - Note updated
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.modulards.com/api/public/v1/sites/site/notes', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp 200 - Note updated
using RestSharp;

var client = new RestClient("https://api.modulards.com/api/public/v1/sites/site/notes");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 - Note updated
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/sites/site/notes")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Update a website's note

**Request**

```json
{
  "note": "<p>Client prefers deployments on Tuesdays. Staging lives at staging.example.com.</p>"
}
```

**Response**

```json
{
  "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"
  }
}
```

**SDK Code**

```python Update a website's note
import requests

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

payload = { "note": "<p>Client prefers deployments on Tuesdays. Staging lives at staging.example.com.</p>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript Update a website's note
const url = 'https://api.modulards.com/api/public/v1/sites/site/notes';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"note":"<p>Client prefers deployments on Tuesdays. Staging lives at staging.example.com.</p>"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Update a website's note
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"note\": \"<p>Client prefers deployments on Tuesdays. Staging lives at staging.example.com.</p>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Update a website's note
require 'uri'
require 'net/http'

url = URI("https://api.modulards.com/api/public/v1/sites/site/notes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"note\": \"<p>Client prefers deployments on Tuesdays. Staging lives at staging.example.com.</p>\"\n}"

response = http.request(request)
puts response.read_body
```

```java Update a website's note
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.modulards.com/api/public/v1/sites/site/notes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"note\": \"<p>Client prefers deployments on Tuesdays. Staging lives at staging.example.com.</p>\"\n}")
  .asString();
```

```php Update a website's note
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.modulards.com/api/public/v1/sites/site/notes', [
  'body' => '{
  "note": "<p>Client prefers deployments on Tuesdays. Staging lives at staging.example.com.</p>"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Update a website's note
using RestSharp;

var client = new RestClient("https://api.modulards.com/api/public/v1/sites/site/notes");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"note\": \"<p>Client prefers deployments on Tuesdays. Staging lives at staging.example.com.</p>\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Update a website's note
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["note": "<p>Client prefers deployments on Tuesdays. Staging lives at staging.example.com.</p>"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/sites/site/notes")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```