Add a guest note

POST https://api.zenoti.com/v1/guests/{guest_id}/notes

Adds a new note to a guest profile.

Before you begin

Permission: Manage API Keys (under Administrator) — Required to access Zenoti APIs.

Endpoint

POST /v1/guests/{guest_id}/notes

Base URL: https://api.zenoti.com

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Path parameters

Parameter Type Required Description
guest_id string (GUID) Yes Guest identifier

Request body

Field Type Required Description
text string Yes Note content

Response

Success (200 OK)

{
  "id": "00000000-0000-0000-0000-f63afa6e2bc6",
  "error": null
}

Response fields

Field Type Description
id string (GUID) New note identifier

Example

curl --request POST \
  --url 'https://api.zenoti.com/v1/guests/e5f6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b/notes' \
  --header 'Authorization: bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{ "text": "Prefers chamomile tea after treatments" }'
const response = await fetch('https://api.zenoti.com/v1/guests/{guest_id}/notes', {
  method: 'POST',
  headers: {
    'Authorization': 'bearer {{access_token}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ text: 'Prefers chamomile tea after treatments' })
});
const data = await response.json();
import requests

response = requests.post(
    'https://api.zenoti.com/v1/guests/{guest_id}/notes',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
    json={'text': 'Prefers chamomile tea after treatments'}
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var content = new StringContent(
    JsonSerializer.Serialize(new { text = "Prefers chamomile tea after treatments" }),
    Encoding.UTF8, "application/json");
var response = await client.PostAsync(
    "https://api.zenoti.com/v1/guests/{guest_id}/notes", content);
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/guests/{guest_id}/notes')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
request['Content-Type'] = 'application/json'
request.body = { text: 'Prefers chamomile tea after treatments' }.to_json
response = http.request(request)
data = JSON.parse(response.body)
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.zenoti.com/v1/guests/{guest_id}/notes');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: bearer {{access_token}}',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(['text' => 'Prefers chamomile tea after treatments']));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);

Error codes

Status Description
400 Bad request — invalid or missing required fields
401 Unauthorized — invalid or expired access token
429 Too many requests — rate limit exceeded (60/min)