Customers

Customer Notes

A CustomerNote is free-form text recorded against a Customer by a staff member, used for capturing context that should follow the customer across visits (e.g. dietary requirements, preferences, behavioural flags).

get/customers/customers/{customerId}/notes

List Customer Notes

listNotes

Returns the notes that have been recorded against the given customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Responses

200
The customer's notes were successfully retrieved
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer's notes were successfully retrieved

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "note": "string",
      "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "first_name": "Alex",
        "last_name": "Morgan"
      },
      "created_at": "2026-01-15T09:30:00+00:00",
      "updated_at": "2026-01-15T09:30:00+00:00"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

post/customers/customers/{customerId}/notes

Create a Customer Note

createNote

Records a new note against the given customer.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.

Request body

notestringrequired
Body of the note in plain text. Notes are operator-only context (not surfaced to guests) and are displayed in reverse-chronological order on the customer record.

Responses

201
The customer's note was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "VIP guest — please welcome by name at reception."
}'

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "note": "VIP guest — please welcome by name at reception."
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "note": "VIP guest — please welcome by name at reception."
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'note' => 'VIP guest — please welcome by name at reception.'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"note": "VIP guest — please welcome by name at reception.",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer's note was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "note": "string",
    "author": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Alex",
      "last_name": "Morgan"
    },
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

put/customers/customers/{customerId}/notes/{noteId}

Update a Customer Note

updateNote

Updates the contents of an existing customer note.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
noteIduuidrequired
The unique identifier of the customer note this operation is scoped to.

Request body

notestringoptional
Replacement body for the note in plain text. The note's author and timestamps are not updated.

Responses

200
The customer's note was successfully retrieved
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "VIP guest — please welcome by name at reception."
}'

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes/00000000-0000-0000-0000-000000000000', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "note": "VIP guest — please welcome by name at reception."
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "note": "VIP guest — please welcome by name at reception."
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'note' => 'VIP guest — please welcome by name at reception.'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"note": "VIP guest — please welcome by name at reception.",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes/00000000-0000-0000-0000-000000000000", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The customer's note was successfully retrieved

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "note": "string",
    "author": {
      "id": "00000000-0000-0000-0000-000000000000",
      "first_name": "Alex",
      "last_name": "Morgan"
    },
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/customers/customers/{customerId}/notes/{noteId}

Delete a Customer Note

deleteNote

Deletes the given customer note.

Path parameters

customerIduuidrequired
The unique identifier of the customer this operation is scoped to. Customer IDs are stable across renames and email changes; treat them as opaque strings even though the underlying format is a UUID.
noteIduuidrequired
The unique identifier of the customer note this operation is scoped to.

Responses

204
The note was successfully deleted
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes/00000000-0000-0000-0000-000000000000",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes/00000000-0000-0000-0000-000000000000', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/customers/customers/00000000-0000-0000-0000-000000000000/notes/00000000-0000-0000-0000-000000000000", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The note was successfully deleted

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}