Create task
curl --request POST \
--url https://api.gospott.com/tasks/_raw \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"content": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"assignedToUserId": "<string>",
"links": [
{
"taskLinkId": "<string>",
"entityId": "<string>"
}
]
}
'import requests
url = "https://api.gospott.com/tasks/_raw"
payload = {
"content": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"assignedToUserId": "<string>",
"links": [
{
"taskLinkId": "<string>",
"entityId": "<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({
content: '<string>',
dueDate: '2023-11-07T05:31:56Z',
assignedToUserId: '<string>',
links: [{taskLinkId: '<string>', entityId: '<string>'}]
})
};
fetch('https://api.gospott.com/tasks/_raw', 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/tasks/_raw",
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([
'content' => '<string>',
'dueDate' => '2023-11-07T05:31:56Z',
'assignedToUserId' => '<string>',
'links' => [
[
'taskLinkId' => '<string>',
'entityId' => '<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/tasks/_raw"
payload := strings.NewReader("{\n \"content\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"assignedToUserId\": \"<string>\",\n \"links\": [\n {\n \"taskLinkId\": \"<string>\",\n \"entityId\": \"<string>\"\n }\n ]\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/tasks/_raw")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"assignedToUserId\": \"<string>\",\n \"links\": [\n {\n \"taskLinkId\": \"<string>\",\n \"entityId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/tasks/_raw")
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 \"content\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"assignedToUserId\": \"<string>\",\n \"links\": [\n {\n \"taskLinkId\": \"<string>\",\n \"entityId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"content": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"isCompleted": true,
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"assignedTo": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"metadata": {
"outreachSequenceId": "<string>",
"outreachSequenceName": "<string>",
"outreachSequenceRunId": "<string>",
"type": "GENERIC_TASK"
},
"links": {
"candidates": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"secondLastName": "<string>",
"avatarUrl": "<string>"
}
],
"vacancies": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"name": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"companyLogoUrl": "<string>"
}
],
"clients": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"name": "<string>",
"logoUrl": "<string>"
}
],
"users": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
}
],
"teams": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>"
}
],
"clientContacts": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"secondLastName": "<string>",
"avatarUrl": "<string>",
"candidateId": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"companyLogoUrl": "<string>"
}
],
"opportunities": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"name": "<string>",
"company": {
"id": "<string>",
"name": "<string>",
"logoUrl": "<string>"
}
}
]
},
"labels": [
{
"id": "<string>",
"name": "<string>",
"colorHex": "<string>"
}
]
}{
"status": 0,
"message": "Invalid task data provided",
"requestId": "<string>",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}Tasks
Create task
Create a new task with optional due date, assignee, and links to entities (candidates, vacancies, clients, etc.).
POST
/
tasks
/
_raw
Create task
curl --request POST \
--url https://api.gospott.com/tasks/_raw \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"content": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"assignedToUserId": "<string>",
"links": [
{
"taskLinkId": "<string>",
"entityId": "<string>"
}
]
}
'import requests
url = "https://api.gospott.com/tasks/_raw"
payload = {
"content": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"assignedToUserId": "<string>",
"links": [
{
"taskLinkId": "<string>",
"entityId": "<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({
content: '<string>',
dueDate: '2023-11-07T05:31:56Z',
assignedToUserId: '<string>',
links: [{taskLinkId: '<string>', entityId: '<string>'}]
})
};
fetch('https://api.gospott.com/tasks/_raw', 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/tasks/_raw",
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([
'content' => '<string>',
'dueDate' => '2023-11-07T05:31:56Z',
'assignedToUserId' => '<string>',
'links' => [
[
'taskLinkId' => '<string>',
'entityId' => '<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/tasks/_raw"
payload := strings.NewReader("{\n \"content\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"assignedToUserId\": \"<string>\",\n \"links\": [\n {\n \"taskLinkId\": \"<string>\",\n \"entityId\": \"<string>\"\n }\n ]\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/tasks/_raw")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"assignedToUserId\": \"<string>\",\n \"links\": [\n {\n \"taskLinkId\": \"<string>\",\n \"entityId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/tasks/_raw")
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 \"content\": \"<string>\",\n \"dueDate\": \"2023-11-07T05:31:56Z\",\n \"assignedToUserId\": \"<string>\",\n \"links\": [\n {\n \"taskLinkId\": \"<string>\",\n \"entityId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"content": "<string>",
"dueDate": "2023-11-07T05:31:56Z",
"isCompleted": true,
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"assignedTo": {
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
},
"metadata": {
"outreachSequenceId": "<string>",
"outreachSequenceName": "<string>",
"outreachSequenceRunId": "<string>",
"type": "GENERIC_TASK"
},
"links": {
"candidates": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"secondLastName": "<string>",
"avatarUrl": "<string>"
}
],
"vacancies": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"name": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"companyLogoUrl": "<string>"
}
],
"clients": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"name": "<string>",
"logoUrl": "<string>"
}
],
"users": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
}
],
"teams": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"name": "<string>",
"avatarUrl": "<string>"
}
],
"clientContacts": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"middleName": "<string>",
"secondLastName": "<string>",
"avatarUrl": "<string>",
"candidateId": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"companyLogoUrl": "<string>"
}
],
"opportunities": [
{
"taskLinkId": "<string>",
"isMention": true,
"id": "<string>",
"name": "<string>",
"company": {
"id": "<string>",
"name": "<string>",
"logoUrl": "<string>"
}
}
]
},
"labels": [
{
"id": "<string>",
"name": "<string>",
"colorHex": "<string>"
}
]
}{
"status": 0,
"message": "Invalid task data provided",
"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
Minimum string length:
1Pattern:
^(?:(?:\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
Response
Task 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))$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))$The user who created the task, or null if the task was created by the system.
Show child attributes
Show child attributes
The user assigned to complete the task, or null if unassigned.
Show child attributes
Show child attributes
Available options:
MANUAL, AI_SUGGESTION, OUTREACH_SEQUENCE_STEP, AUTOMATION - Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
All entities linked to this task, grouped by entity type. Links can be created explicitly or via @mentions in the task content.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I

