Create a note
curl --request POST \
--url https://api.gospott.com/notes \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"content": "<string>",
"links": [
{
"entityId": "<string>"
}
],
"meetingId": "<string>",
"labelIds": [
"<string>"
],
"createdById": "<string>"
}
'import requests
url = "https://api.gospott.com/notes"
payload = {
"title": "<string>",
"content": "<string>",
"links": [{ "entityId": "<string>" }],
"meetingId": "<string>",
"labelIds": ["<string>"],
"createdById": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
content: '<string>',
links: [{entityId: '<string>'}],
meetingId: '<string>',
labelIds: ['<string>'],
createdById: '<string>'
})
};
fetch('https://api.gospott.com/notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gospott.com/notes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'content' => '<string>',
'links' => [
[
'entityId' => '<string>'
]
],
'meetingId' => '<string>',
'labelIds' => [
'<string>'
],
'createdById' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gospott.com/notes"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"links\": [\n {\n \"entityId\": \"<string>\"\n }\n ],\n \"meetingId\": \"<string>\",\n \"labelIds\": [\n \"<string>\"\n ],\n \"createdById\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gospott.com/notes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"links\": [\n {\n \"entityId\": \"<string>\"\n }\n ],\n \"meetingId\": \"<string>\",\n \"labelIds\": [\n \"<string>\"\n ],\n \"createdById\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"links\": [\n {\n \"entityId\": \"<string>\"\n }\n ],\n \"meetingId\": \"<string>\",\n \"labelIds\": [\n \"<string>\"\n ],\n \"createdById\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
],
"links": [
{
"id": "<string>",
"noteId": "<string>",
"entityType": "candidate",
"candidate": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"secondLastName": "<string>",
"avatarUrl": "<string>"
}
}
],
"meeting": {
"id": "<string>",
"meetingProvider": "googleMeet",
"title": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"hasTranscript": true,
"transcripts": [
{
"id": "<string>"
}
]
},
"call": {
"id": "<string>",
"provider": "TELNYX",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"hasTranscript": true,
"transcript": {
"id": "<string>"
}
},
"audioRecording": {
"id": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"hasTranscript": true,
"transcript": {
"id": "<string>"
}
},
"type": "manual",
"source": "phone",
"pinned": true,
"shouldPoll": true,
"labels": [
{
"id": "<string>",
"name": "<string>",
"colorHex": "<string>"
}
]
}{
"status": 0,
"message": "Content is required",
"requestId": "<string>",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}Notes
Create a note
Creates a new note. You can optionally link the note to candidates, jobs, applications, companies, client contacts, interviews, or opportunities.
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 '
{
"title": "<string>",
"content": "<string>",
"links": [
{
"entityId": "<string>"
}
],
"meetingId": "<string>",
"labelIds": [
"<string>"
],
"createdById": "<string>"
}
'import requests
url = "https://api.gospott.com/notes"
payload = {
"title": "<string>",
"content": "<string>",
"links": [{ "entityId": "<string>" }],
"meetingId": "<string>",
"labelIds": ["<string>"],
"createdById": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
content: '<string>',
links: [{entityId: '<string>'}],
meetingId: '<string>',
labelIds: ['<string>'],
createdById: '<string>'
})
};
fetch('https://api.gospott.com/notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gospott.com/notes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'content' => '<string>',
'links' => [
[
'entityId' => '<string>'
]
],
'meetingId' => '<string>',
'labelIds' => [
'<string>'
],
'createdById' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gospott.com/notes"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"links\": [\n {\n \"entityId\": \"<string>\"\n }\n ],\n \"meetingId\": \"<string>\",\n \"labelIds\": [\n \"<string>\"\n ],\n \"createdById\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gospott.com/notes")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"links\": [\n {\n \"entityId\": \"<string>\"\n }\n ],\n \"meetingId\": \"<string>\",\n \"labelIds\": [\n \"<string>\"\n ],\n \"createdById\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/notes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"content\": \"<string>\",\n \"links\": [\n {\n \"entityId\": \"<string>\"\n }\n ],\n \"meetingId\": \"<string>\",\n \"labelIds\": [\n \"<string>\"\n ],\n \"createdById\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
],
"links": [
{
"id": "<string>",
"noteId": "<string>",
"entityType": "candidate",
"candidate": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"secondLastName": "<string>",
"avatarUrl": "<string>"
}
}
],
"meeting": {
"id": "<string>",
"meetingProvider": "googleMeet",
"title": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"hasTranscript": true,
"transcripts": [
{
"id": "<string>"
}
]
},
"call": {
"id": "<string>",
"provider": "TELNYX",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"hasTranscript": true,
"transcript": {
"id": "<string>"
}
},
"audioRecording": {
"id": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"hasTranscript": true,
"transcript": {
"id": "<string>"
}
},
"type": "manual",
"source": "phone",
"pinned": true,
"shouldPoll": true,
"labels": [
{
"id": "<string>",
"name": "<string>",
"colorHex": "<string>"
}
]
}{
"status": 0,
"message": "Content is required",
"requestId": "<string>",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}Authorizations
API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.
Body
application/json
The content of the note in HTML format.
Available options:
phone, phoneInbound, phoneOutbound, inPerson, onlineMeeting, callAttempted Show child attributes
Show child attributes
The ID of the user to attribute the note to.
Response
Note created successfully.
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Show child attributes
Show child attributes
Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
manual, aiSummary, automation Available options:
phone, phoneInbound, phoneOutbound, inPerson, onlineMeeting, callAttempted, null Show child attributes
Show child attributes
Was this page helpful?