Sign in

v1

latestOpenAPI 3.1.02026-07-226875162.5 KB
Note

Reserve Note GUID

Reserve a note GUID for later use in note creation. This allows you to:

  • Get a GUID before actually creating the note
  • Use the reserved GUID when creating a note with POST /v1/notes (internal API)
  • Reservation expires after 1 hour if not used

Use case: When you need to know the note GUID before the note content is ready, such as setting up webhooks or references in advance.

post/v1/external/notes/guids

Request body

titlestring

If provided, sets the title for the note to be created.

Example request

{
  "title": "Weekly Team Standup"
}

Response

Note GUID successfully reserved

guidstring required

Reserved note GUID that can be used for note creation

titlestring nullable

Title of the note if provided during reservation

expiresAtstring date-time required

ISO-8601 timestamp when the reservation expires (1 hour from creation)

createdAtstring date-time required

ISO-8601 timestamp when the reservation was created

Example response

{
  "guid": "x6DjzdpXqkEcU",
  "title": "Weekly Team Standup",
  "expiresAt": "2024-01-15T11:30:00Z",
  "createdAt": "2024-01-15T10:30:00Z"
}