Upload attachment

curl --request POST \
  --url https://{your-subdomain}.neetodesk.com/api/external/v2/attachments \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Api-Key: <x-api-key>' \
  --form file='@example-file'

import requests

url = "https://{your-subdomain}.neetodesk.com/api/external/v2/attachments"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"X-Api-Key": "<x-api-key>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'POST', headers: {'X-Api-Key': '<x-api-key>'}};

options.body = form;

fetch('https://{your-subdomain}.neetodesk.com/api/external/v2/attachments', 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://{your-subdomain}.neetodesk.com/api/external/v2/attachments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "X-Api-Key: <x-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://{your-subdomain}.neetodesk.com/api/external/v2/attachments"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{your-subdomain}.neetodesk.com/api/external/v2/attachments")
  .header("X-Api-Key", "<x-api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{your-subdomain}.neetodesk.com/api/external/v2/attachments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<x-api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

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

{
  "id": "aaaabbbb-cccc-dddd-eeee-ffff00004444",
  "signed_id": "eyJfcmFpbHMiOnsiZGF0YSI6IjEyMyJ9fQ==",
  "filename": "report.pdf",
  "content_type": "application/pdf",
  "byte_size": 20481,
  "checksum": "Y2hlY2tzdW1leGFtcGxl",
  "blob_url": "https://spinkart.neetodesk.com/rails/active_storage/blobs/report.pdf",
  "created_at": "2025-12-01T10:15:00Z"
}

Attachments

Upload attachment

Uploads a file and returns a signed_id for it. Pass that id in attachments on Create ticket or Create comment to attach the file.

The upload is a two-step flow because a file has no home until the record it belongs to exists. An uploaded file that is never attached is cleaned up automatically.

A signed_id can only be attached in the workspace that uploaded it.

Two different size limits apply, so it is worth knowing both. This endpoint accepts a file up to the workspace upload limit, 50 MB by default. Attaching it to a ticket or comment applies the smaller attachment limit, 10 MB by default, and a file over that is rejected at attach time rather than silently dropped.

POST

attachments

Upload attachment

curl --request POST \
  --url https://{your-subdomain}.neetodesk.com/api/external/v2/attachments \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Api-Key: <x-api-key>' \
  --form file='@example-file'

import requests

url = "https://{your-subdomain}.neetodesk.com/api/external/v2/attachments"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"X-Api-Key": "<x-api-key>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'POST', headers: {'X-Api-Key': '<x-api-key>'}};

options.body = form;

fetch('https://{your-subdomain}.neetodesk.com/api/external/v2/attachments', 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://{your-subdomain}.neetodesk.com/api/external/v2/attachments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "X-Api-Key: <x-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://{your-subdomain}.neetodesk.com/api/external/v2/attachments"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{your-subdomain}.neetodesk.com/api/external/v2/attachments")
  .header("X-Api-Key", "<x-api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{your-subdomain}.neetodesk.com/api/external/v2/attachments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<x-api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

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

{
  "id": "aaaabbbb-cccc-dddd-eeee-ffff00004444",
  "signed_id": "eyJfcmFpbHMiOnsiZGF0YSI6IjEyMyJ9fQ==",
  "filename": "report.pdf",
  "content_type": "application/pdf",
  "byte_size": 20481,
  "checksum": "Y2hlY2tzdW1leGFtcGxl",
  "blob_url": "https://spinkart.neetodesk.com/rails/active_storage/blobs/report.pdf",
  "created_at": "2025-12-01T10:15:00Z"
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key

string

default:your-api-key

required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Body

multipart/form-data

file

required

The file to upload. Sent as multipart/form-data.

Response

Created - File uploaded successfully

string

Example:

"aaaabbbb-cccc-dddd-eeee-ffff00004444"

signed_id

string

Pass this to attachments on ticket or comment create to attach the file. It is only accepted in the workspace that uploaded it.

Example:

"eyJfcmFpbHMiOnsiZGF0YSI6IjEyMyJ9fQ=="

filename

string

Example:

"report.pdf"

content_type

string

Example:

"application/pdf"

byte_size

integer

Example:

20481

checksum

string

Example:

"Y2hlY2tzdW1leGFtcGxl"

blob_url

string

URL the uploaded file can be fetched from.

Example:

"https://spinkart.neetodesk.com/rails/active_storage/blobs/report.pdf"

created_at

string<date-time>

read-only

Example:

"2025-12-01T10:15:00Z"

Getting Started

Tickets

Comments

Attachments

Customers

Reports

Team Members

V1 API (Deprecated)

Upload attachment

Headers

Body

Response