Sign in

v1

latestOpenAPI 3.1.02026-07-223614164.6 KB
Notes

Create a note

Create a new note in the workspace.

post/v1/notes

Request body

visibility'public' | 'private' required

The visibility of the note.

  • public: The note is visible to all users in the workspace.
  • private: The note is visible only to the current user.
contentstring required

The content of the note. Can be in plain text or in markdown format.

Example request

{
  "entity": {
    "id": "per_55175e81-9a52-4ac3-930e-82792c23499b"
  },
  "content": "This is a note about **John Doe**",
  "parentNote": {
    "id": "nte_14c18444-a0c7-459a-86b0-ccd70ebcd65c"
  }
}

Response

The note created in the workspace.

deprecationsstring[]

Example response

{
  "data": {
    "id": "nte_91118b73-5a75-480b-b8e3-a33671c35cdc",
    "entity": {
      "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
      "entityType": "person",
      "fullName": "John Doe"
    },
    "visibility": "public",
    "content": "This is a note about John Doe",
    "author": {
      "type": "user",
      "id": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
      "fullName": "John Doe",
      "email": "john.doe@example.com",
      "deleted": false
    },
    "createdAt": "2021-01-01T00:00:00.000Z",
    "parentNote": {
      "id": "nte_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
      "entity": {
        "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
        "entityType": "person",
        "fullName": "John Doe"
      },
      "content": "This is a parent note about John Doe",
      "visibility": "public",
      "author": {
        "type": "user",
        "id": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
        "fullName": "John Doe",
        "email": "john.doe@example.com",
        "deleted": false
      },
      "createdAt": "2021-01-01T00:00:00.000Z",
      "deleted": false
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}