Assign temporary attachments to records

curl --request POST \
  --url https://api.gospott.com/attachments/temporary/assign \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "attachments": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "type": {
        "id": "<string>"
      },
      "name": "John_Doe_CV_2026.pdf"
    }
  ],
  "candidateIds": [
    "<string>"
  ],
  "companyIds": [
    "<string>"
  ],
  "vacancyIds": [
    "<string>"
  ],
  "candidateId": "550e8400-e29b-41d4-a716-446655440000",
  "companyId": "550e8400-e29b-41d4-a716-446655440001",
  "vacancyId": "550e8400-e29b-41d4-a716-446655440002"
}
'

import requests

url = "https://api.gospott.com/attachments/temporary/assign"

payload = {
    "attachments": [
        {
            "id": "550e8400-e29b-41d4-a716-446655440003",
            "type": { "id": "<string>" },
            "name": "John_Doe_CV_2026.pdf"
        }
    ],
    "candidateIds": ["<string>"],
    "companyIds": ["<string>"],
    "vacancyIds": ["<string>"],
    "candidateId": "550e8400-e29b-41d4-a716-446655440000",
    "companyId": "550e8400-e29b-41d4-a716-446655440001",
    "vacancyId": "550e8400-e29b-41d4-a716-446655440002"
}
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({
    attachments: [
      {
        id: '550e8400-e29b-41d4-a716-446655440003',
        type: {id: '<string>'},
        name: 'John_Doe_CV_2026.pdf'
      }
    ],
    candidateIds: ['<string>'],
    companyIds: ['<string>'],
    vacancyIds: ['<string>'],
    candidateId: '550e8400-e29b-41d4-a716-446655440000',
    companyId: '550e8400-e29b-41d4-a716-446655440001',
    vacancyId: '550e8400-e29b-41d4-a716-446655440002'
  })
};

fetch('https://api.gospott.com/attachments/temporary/assign', 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/attachments/temporary/assign",
  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([
    'attachments' => [
        [
                'id' => '550e8400-e29b-41d4-a716-446655440003',
                'type' => [
                                'id' => '<string>'
                ],
                'name' => 'John_Doe_CV_2026.pdf'
        ]
    ],
    'candidateIds' => [
        '<string>'
    ],
    'companyIds' => [
        '<string>'
    ],
    'vacancyIds' => [
        '<string>'
    ],
    'candidateId' => '550e8400-e29b-41d4-a716-446655440000',
    'companyId' => '550e8400-e29b-41d4-a716-446655440001',
    'vacancyId' => '550e8400-e29b-41d4-a716-446655440002'
  ]),
  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/attachments/temporary/assign"

	payload := strings.NewReader("{\n  \"attachments\": [\n    {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440003\",\n      \"type\": {\n        \"id\": \"<string>\"\n      },\n      \"name\": \"John_Doe_CV_2026.pdf\"\n    }\n  ],\n  \"candidateIds\": [\n    \"<string>\"\n  ],\n  \"companyIds\": [\n    \"<string>\"\n  ],\n  \"vacancyIds\": [\n    \"<string>\"\n  ],\n  \"candidateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"companyId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"vacancyId\": \"550e8400-e29b-41d4-a716-446655440002\"\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/attachments/temporary/assign")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"attachments\": [\n    {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440003\",\n      \"type\": {\n        \"id\": \"<string>\"\n      },\n      \"name\": \"John_Doe_CV_2026.pdf\"\n    }\n  ],\n  \"candidateIds\": [\n    \"<string>\"\n  ],\n  \"companyIds\": [\n    \"<string>\"\n  ],\n  \"vacancyIds\": [\n    \"<string>\"\n  ],\n  \"candidateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"companyId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"vacancyId\": \"550e8400-e29b-41d4-a716-446655440002\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gospott.com/attachments/temporary/assign")

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  \"attachments\": [\n    {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440003\",\n      \"type\": {\n        \"id\": \"<string>\"\n      },\n      \"name\": \"John_Doe_CV_2026.pdf\"\n    }\n  ],\n  \"candidateIds\": [\n    \"<string>\"\n  ],\n  \"companyIds\": [\n    \"<string>\"\n  ],\n  \"vacancyIds\": [\n    \"<string>\"\n  ],\n  \"candidateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"companyId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"vacancyId\": \"550e8400-e29b-41d4-a716-446655440002\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": 0,
  "message": "ATTACHMENT_TYPE_NOT_ALLOWED_FOR_RECORD_TYPE",
  "requestId": "<string>",
  "statusCode": 400,
  "error": "Bad Request"
}

{
  "status": 0,
  "message": "<string>",
  "requestId": "<string>"
}

{
  "status": 0,
  "message": "Attachment not found",
  "requestId": "<string>",
  "statusCode": 404,
  "error": "Not Found"
}

{
  "status": 0,
  "message": "<string>",
  "requestId": "<string>"
}

Attachments

Assign temporary attachments to records

Step 2 of the two-step upload flow: assigns temporary attachments previously created via POST /attachments/temporary to one or more records (candidate, company, or vacancy), making them permanent. The attachment’s type is intended to be set here — each attachment specifies a type, either a predefined type ({ name }) or a custom, tenant-defined type ({ id }), and can optionally be renamed. At least one of candidateId, companyId, or vacancyId must be provided. The type must be allowed for all records the attachment is linked to: the predefined CV type can only be assigned to attachments linked to a candidate, and custom types define which record types they support.

POST

attachments

temporary

assign

Assign temporary attachments to records

curl --request POST \
  --url https://api.gospott.com/attachments/temporary/assign \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "attachments": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "type": {
        "id": "<string>"
      },
      "name": "John_Doe_CV_2026.pdf"
    }
  ],
  "candidateIds": [
    "<string>"
  ],
  "companyIds": [
    "<string>"
  ],
  "vacancyIds": [
    "<string>"
  ],
  "candidateId": "550e8400-e29b-41d4-a716-446655440000",
  "companyId": "550e8400-e29b-41d4-a716-446655440001",
  "vacancyId": "550e8400-e29b-41d4-a716-446655440002"
}
'

import requests

url = "https://api.gospott.com/attachments/temporary/assign"

payload = {
    "attachments": [
        {
            "id": "550e8400-e29b-41d4-a716-446655440003",
            "type": { "id": "<string>" },
            "name": "John_Doe_CV_2026.pdf"
        }
    ],
    "candidateIds": ["<string>"],
    "companyIds": ["<string>"],
    "vacancyIds": ["<string>"],
    "candidateId": "550e8400-e29b-41d4-a716-446655440000",
    "companyId": "550e8400-e29b-41d4-a716-446655440001",
    "vacancyId": "550e8400-e29b-41d4-a716-446655440002"
}
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({
    attachments: [
      {
        id: '550e8400-e29b-41d4-a716-446655440003',
        type: {id: '<string>'},
        name: 'John_Doe_CV_2026.pdf'
      }
    ],
    candidateIds: ['<string>'],
    companyIds: ['<string>'],
    vacancyIds: ['<string>'],
    candidateId: '550e8400-e29b-41d4-a716-446655440000',
    companyId: '550e8400-e29b-41d4-a716-446655440001',
    vacancyId: '550e8400-e29b-41d4-a716-446655440002'
  })
};

fetch('https://api.gospott.com/attachments/temporary/assign', 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/attachments/temporary/assign",
  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([
    'attachments' => [
        [
                'id' => '550e8400-e29b-41d4-a716-446655440003',
                'type' => [
                                'id' => '<string>'
                ],
                'name' => 'John_Doe_CV_2026.pdf'
        ]
    ],
    'candidateIds' => [
        '<string>'
    ],
    'companyIds' => [
        '<string>'
    ],
    'vacancyIds' => [
        '<string>'
    ],
    'candidateId' => '550e8400-e29b-41d4-a716-446655440000',
    'companyId' => '550e8400-e29b-41d4-a716-446655440001',
    'vacancyId' => '550e8400-e29b-41d4-a716-446655440002'
  ]),
  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/attachments/temporary/assign"

	payload := strings.NewReader("{\n  \"attachments\": [\n    {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440003\",\n      \"type\": {\n        \"id\": \"<string>\"\n      },\n      \"name\": \"John_Doe_CV_2026.pdf\"\n    }\n  ],\n  \"candidateIds\": [\n    \"<string>\"\n  ],\n  \"companyIds\": [\n    \"<string>\"\n  ],\n  \"vacancyIds\": [\n    \"<string>\"\n  ],\n  \"candidateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"companyId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"vacancyId\": \"550e8400-e29b-41d4-a716-446655440002\"\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/attachments/temporary/assign")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"attachments\": [\n    {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440003\",\n      \"type\": {\n        \"id\": \"<string>\"\n      },\n      \"name\": \"John_Doe_CV_2026.pdf\"\n    }\n  ],\n  \"candidateIds\": [\n    \"<string>\"\n  ],\n  \"companyIds\": [\n    \"<string>\"\n  ],\n  \"vacancyIds\": [\n    \"<string>\"\n  ],\n  \"candidateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"companyId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"vacancyId\": \"550e8400-e29b-41d4-a716-446655440002\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gospott.com/attachments/temporary/assign")

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  \"attachments\": [\n    {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440003\",\n      \"type\": {\n        \"id\": \"<string>\"\n      },\n      \"name\": \"John_Doe_CV_2026.pdf\"\n    }\n  ],\n  \"candidateIds\": [\n    \"<string>\"\n  ],\n  \"companyIds\": [\n    \"<string>\"\n  ],\n  \"vacancyIds\": [\n    \"<string>\"\n  ],\n  \"candidateId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"companyId\": \"550e8400-e29b-41d4-a716-446655440001\",\n  \"vacancyId\": \"550e8400-e29b-41d4-a716-446655440002\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": 0,
  "message": "ATTACHMENT_TYPE_NOT_ALLOWED_FOR_RECORD_TYPE",
  "requestId": "<string>",
  "statusCode": 400,
  "error": "Bad Request"
}

{
  "status": 0,
  "message": "<string>",
  "requestId": "<string>"
}

{
  "status": 0,
  "message": "Attachment not found",
  "requestId": "<string>",
  "statusCode": 404,
  "error": "Not Found"
}

{
  "status": 0,
  "message": "<string>",
  "requestId": "<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

attachments

object[]

required

List of temporary attachments to assign. Each attachment must include the ID returned from the upload endpoint, the desired attachment type, and optionally a new name for the file.

Show child attributes

candidateIds

string[]

IDs of the candidates to link the attachments to. Fully replaces the existing candidate links. At least one of candidateIds, companyIds, or vacancyIds must be provided.

Maximum array length: 100

Minimum string length: 1

companyIds

string[]

IDs of the companies to link the attachments to. Fully replaces the existing company links. At least one of candidateIds, companyIds, or vacancyIds must be provided.

Maximum array length: 100

Minimum string length: 1

vacancyIds

string[]

IDs of the vacancies/jobs to link the attachments to. Fully replaces the existing vacancy links. At least one of candidateIds, companyIds, or vacancyIds must be provided.

Maximum array length: 100

Minimum string length: 1

candidateId

string

deprecated

[DEPRECATED] Use candidateIds instead. ID of a single candidate to link the attachments to; merged into candidateIds.

Minimum string length: 1

Example:

"550e8400-e29b-41d4-a716-446655440000"

companyId

string

deprecated

[DEPRECATED] Use companyIds instead. ID of a single company to link the attachments to; merged into companyIds.

Minimum string length: 1

Example:

"550e8400-e29b-41d4-a716-446655440001"

vacancyId

string

deprecated

[DEPRECATED] Use vacancyIds instead. ID of a single vacancy/job to link the attachments to; merged into vacancyIds.

Minimum string length: 1

Example:

"550e8400-e29b-41d4-a716-446655440002"

Response

Attachments assigned successfully

Upload temporary attachments List attachment types

Overview

Public API

Applications

Attachments

Candidates

Client Contacts

Client Hierarchies

Clients

Companies

Job Descriptions

Meetings

Offices

Application Pipeline

Jobs

Users

Retained Searches

Opportunities

Note Labels

Notes

Search People

Lists

Candidate Lists

Client Lists

Client Contact Lists

Custom Attributes

Job Boards

Job Portal

Placements

Tasks

Teams

Transcripts

Enrichments

Consents

Outreach Sequences

Skills

Candidate Portal

Assign temporary attachments to records

Authorizations

Body

Response