Skip to main content
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>"
    }
  ]
}
'
{
  "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>"
    }
  ]
}

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
Minimum string length: 1
​
dueDate
required
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))$
​
assignedToUserId
string | null
required
​
links
object[]
required

Response

Task created successfully

​
id
string
required
​
content
string
required
​
dueDate
required
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))$
​
isCompleted
boolean
required
​
completedAt
required
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))$
​
createdAt
required
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))$
​
createdBy
object
required

The user who created the task, or null if the task was created by the system.

​
assignedTo
object
required

The user assigned to complete the task, or null if unassigned.

​
source
enum<string>
required
Available options:
MANUAL,
AI_SUGGESTION,
OUTREACH_SEQUENCE_STEP,
AUTOMATION
​
metadata
object
required
​
links
object
required

All entities linked to this task, grouped by entity type. Links can be created explicitly or via @mentions in the task content.

​
labels
object[]
required