Notes

Read and create the notes pinned to a social set's calendar via the Pallyy API: reminders, recurring notes, and events imported from Google Calendar.

A note is a reminder pinned to a day on a social set's calendar. Notes are created in Pallyy, from a shared calendar, imported from Google Calendar, or created via the API, and a recurring note appears once per occurrence: each occurrence is its own note with its own id.

Creating or editing a note requires the notes:write scope, see authentication.

List notes

GET /v1/notes
ParameterRequiredMeaning
socialSetIdYesThe social set whose notes to list
filters[startDate]YesISO 8601, notes scheduled at or after this time
filters[endDate]YesISO 8601, notes scheduled before this time

The range can span at most 366 days, a wider or reversed range returns a 400. Every note in the range is returned, sorted by scheduledAt ascending. This list is not paginated.

curl "https://app.pallyy.com/api/v1/notes?socialSetId=SET_ID&filters[startDate]=2026-09-01T00:00:00.000Z&filters[endDate]=2026-10-01T00:00:00.000Z" \
  -H "Authorization: Bearer pallyy_your_api_key"

Get a note

GET /v1/notes/{id}

Returns a single note, or a 404 if it does not exist or is outside the key's access.

Create a note

POST /v1/notes

Requires notes:write. Returns the created note with a 201.

FieldRequiredMeaning
socialSetIdYesThe social set to pin the note to
contentYesThe note text, up to 1024 characters
hexColorYesThe note's colour, one of #faf785, #fff0db, #ffe5e5, #ffe4f7, #f2edff, #e1effc, #e4f8e2, #eee2d7, #f2f2f2
scheduledAtYesISO 8601 date-time the note is pinned to
repeatNo{ "interval": "DAY" | "WEEK" | "MONTH" | "YEAR", "occurrences": 2-100 }

Omitting repeat creates a single ONE_TIME note. Passing it creates a RECURRING series: the call returns the first occurrence, and the rest are created alongside it, each as its own note spaced by interval for occurrences total notes.

curl -X POST https://app.pallyy.com/api/v1/notes \
  -H "Authorization: Bearer pallyy_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "socialSetId": "SET_ID",
    "content": "Product launch, prepare the stories",
    "hexColor": "#faf785",
    "scheduledAt": "2026-09-14T00:00:00.000Z"
  }'

Update a note

PATCH /v1/notes/{id}

Requires notes:write. The update is partial: omitted fields keep their saved values. For a RECURRING note, the update only applies to that occurrence, the rest of the series is unaffected.

FieldMeaning
contentThe note text, up to 1024 characters
hexColorThe note's colour, one of #faf785, #fff0db, #ffe5e5, #ffe4f7, #f2edff, #e1effc, #e4f8e2, #eee2d7, #f2f2f2
scheduledAtISO 8601 date-time the note is pinned to. Can't be changed on a RECURRING note or one imported from Google Calendar
curl -X PATCH https://app.pallyy.com/api/v1/notes/NOTE_ID \
  -H "Authorization: Bearer pallyy_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Product launch, prepare the stories and reels"
  }'

The note object

{
  "id": "665f1c2ab7e2a4d1f0a1b2c6",
  "socialSetId": "665f1c2ab7e2a4d1f0a1b2c3",
  "type": "ONE_TIME",
  "source": { "type": "APP" },
  "content": "Product launch, prepare the stories",
  "hexColor": "#faf785",
  "scheduledAt": "2026-09-14T00:00:00.000Z",
  "createdAt": "2026-08-20T10:00:00.000Z"
}
FieldTypeMeaning
idstringThe note id
socialSetIdstringThe social set the note belongs to
typestringONE_TIME, or RECURRING for one occurrence of a repeating note
source.typestringWhere the note came from: APP, SHARED_CALENDAR, or GOOGLE_IMPORT
contentstringThe note text, up to 1024 characters
hexColorstringThe note's colour in Pallyy, one of #faf785, #fff0db, #ffe5e5, #ffe4f7, #f2edff, #e1effc, #e4f8e2, #eee2d7, #f2f2f2
scheduledAtstringISO 8601 time the note is pinned to
createdAtstringISO 8601 time the note was created
View as markdown

More in Endpoints

Questions about the API? Email us at hey@pallyy.com and we'll get back to you.