Skip to main content
POST
/
notes
Create a note
curl --request POST \
  --url https://api.gospott.com/notes \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "content": "<string>",
  "title": "<string>",
  "source": "phone",
  "links": [
    {
      "entityType": "candidate",
      "entityId": "<string>"
    }
  ],
  "meetingId": "<string>",
  "labelIds": [
    "<string>"
  ]
}
'
{
  "links": [
    {
      "entityType": "candidate",
      "candidate": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "middleName": "<string>",
        "secondLastName": "<string>",
        "avatarUrl": "<string>"
      },
      "id": "<string>",
      "noteId": "<string>"
    }
  ],
  "type": "manual",
  "source": "phone",
  "id": "<string>",
  "title": "<string>",
  "content": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "lastEditedAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "id": "<string>",
    "name": "<string>",
    "avatarUrl": "<string>",
    "deactivatedAt": "2023-11-07T05:31:56Z"
  },
  "editors": [
    {
      "editedBy": {
        "id": "<string>",
        "name": "<string>",
        "avatarUrl": "<string>",
        "deactivatedAt": "2023-11-07T05:31:56Z"
      },
      "editedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meeting": {
    "meetingProvider": "googleMeet",
    "id": "<string>",
    "title": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "hasTranscript": true
  },
  "call": {
    "provider": "TELNYX",
    "id": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "hasTranscript": true
  },
  "pinned": true,
  "shouldPoll": true,
  "labels": [
    {
      "id": "<string>",
      "name": "<string>",
      "colorHex": "<string>"
    }
  ],
  "titleHighlight": "<string>",
  "contentHighlight": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Body

application/json
content
string
required

The content of the note in HTML format.

title
string | null
required
source
enum<string>
Available options:
phone,
inPerson,
onlineMeeting,
callAttempted
meetingId
string
labelIds
string[]

Response

Note created successfully.

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
type
enum<string>
required
Available options:
manual,
aiSummary
source
enum<string> | null
required
Available options:
phone,
inPerson,
onlineMeeting,
callAttempted
id
string
required
title
string | null
required
content
string
required
createdAt
string<date-time>
required
lastEditedAt
string<date-time>
required
createdBy
object
required
editors
object[]
required
meeting
object
required
call
object
required
pinned
boolean
required
shouldPoll
boolean
required
labels
object[]
required
titleHighlight
string
contentHighlight
string