Skip to main content
POST
/
attachments
Register a finalised attachment row after S3 upload
curl --request POST \
  --url https://api.arcuserp.com/v1/attachments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parent_type": "<string>",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "filename": "<string>",
  "mime_type": "<string>",
  "size_bytes": 123,
  "s3_key": "<string>",
  "s3_bucket": "<string>",
  "s3_etag": "<string>",
  "checksum_sha256": "<string>",
  "is_public": false,
  "expires_at": "2023-11-07T05:31:56Z",
  "metadata": {}
}
'
import requests

url = "https://api.arcuserp.com/v1/attachments"

payload = {
    "parent_type": "<string>",
    "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "filename": "<string>",
    "mime_type": "<string>",
    "size_bytes": 123,
    "s3_key": "<string>",
    "s3_bucket": "<string>",
    "s3_etag": "<string>",
    "checksum_sha256": "<string>",
    "is_public": False,
    "expires_at": "2023-11-07T05:31:56Z",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    parent_type: '<string>',
    parent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    filename: '<string>',
    mime_type: '<string>',
    size_bytes: 123,
    s3_key: '<string>',
    s3_bucket: '<string>',
    s3_etag: '<string>',
    checksum_sha256: '<string>',
    is_public: false,
    expires_at: '2023-11-07T05:31:56Z',
    metadata: {}
  })
};

fetch('https://api.arcuserp.com/v1/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://api.arcuserp.com/v1/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 => json_encode([
    'parent_type' => '<string>',
    'parent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'filename' => '<string>',
    'mime_type' => '<string>',
    'size_bytes' => 123,
    's3_key' => '<string>',
    's3_bucket' => '<string>',
    's3_etag' => '<string>',
    'checksum_sha256' => '<string>',
    'is_public' => false,
    'expires_at' => '2023-11-07T05:31:56Z',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.arcuserp.com/v1/attachments"

	payload := strings.NewReader("{\n  \"parent_type\": \"<string>\",\n  \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"filename\": \"<string>\",\n  \"mime_type\": \"<string>\",\n  \"size_bytes\": 123,\n  \"s3_key\": \"<string>\",\n  \"s3_bucket\": \"<string>\",\n  \"s3_etag\": \"<string>\",\n  \"checksum_sha256\": \"<string>\",\n  \"is_public\": false,\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.arcuserp.com/v1/attachments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"parent_type\": \"<string>\",\n  \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"filename\": \"<string>\",\n  \"mime_type\": \"<string>\",\n  \"size_bytes\": 123,\n  \"s3_key\": \"<string>\",\n  \"s3_bucket\": \"<string>\",\n  \"s3_etag\": \"<string>\",\n  \"checksum_sha256\": \"<string>\",\n  \"is_public\": false,\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/attachments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"parent_type\": \"<string>\",\n  \"parent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"filename\": \"<string>\",\n  \"mime_type\": \"<string>\",\n  \"size_bytes\": 123,\n  \"s3_key\": \"<string>\",\n  \"s3_bucket\": \"<string>\",\n  \"s3_etag\": \"<string>\",\n  \"checksum_sha256\": \"<string>\",\n  \"is_public\": false,\n  \"expires_at\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "attachment",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_type": "<string>",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "filename": "<string>",
  "mime_type": "<string>",
  "size_bytes": 123,
  "s3_bucket": "<string>",
  "s3_key": "<string>",
  "s3_etag": "<string>",
  "checksum_sha256": "<string>",
  "uploaded_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "uploaded_via": "web",
  "is_public": false,
  "expires_at": "2023-11-07T05:31:56Z",
  "external_source": "<string>",
  "external_id": "<string>",
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "s3_deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z"
}
{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

​
Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Body

application/json
​
parent_type
string
required
​
parent_id
string<uuid>
required
​
filename
string
required
​
mime_type
string
required
​
size_bytes
integer<int64>
required
​
s3_key
string
required
​
s3_bucket
string

S3 bucket; defaults to canonical entity bucket if omitted.

​
s3_etag
string | null
​
checksum_sha256
string | null
​
is_public
boolean
default:false
​
expires_at
string<date-time> | null
​
metadata
object

Response

Attachment created

A file attached to a parent resource via parent_type + parent_id. The two-step upload flow (POST /attachments/upload-url then POST /attachments) persists bytes in S3 and the row in public.attachments. s3_bucket and s3_key are operator-internal; clients fetch the file by minting a fresh presigned URL via POST /attachments/{id}/download-url. Soft-delete clears deleted_at but does NOT delete the S3 object; an out-of-band sweeper sets s3_deleted_at once bytes are purged. Scope: attachments:read / attachments:write / attachments:delete.

​
id
string<uuid>
read-only
​
object
string
Example:

"attachment"

​
entity_id
string<uuid>
read-only
​
parent_type
string

Parent resource family (order, account, ap_bill, etc.). 1..30 chars.

​
parent_id
string<uuid>
​
filename
string

Operator-supplied file name. 1..255 chars.

​
mime_type
string

Content type at upload time. 1..100 chars.

​
size_bytes
integer<int64>

File size at upload time in bytes.

​
s3_bucket
string
read-only

Operator-internal; clients should never need this.

​
s3_key
string
read-only

Operator-internal; clients should never need this.

​
s3_etag
string | null
read-only
​
checksum_sha256
string | null
read-only

SHA-256 of the bytes if supplied at upload time.

​
uploaded_by_user_id
string<uuid> | null
read-only
​
uploaded_via
enum<string>
default:web

Origin of the upload. Set automatically; not caller-writable.

Available options:
web,
api,
portal,
migration
​
is_public
boolean
default:false

If true, exposes via tokenized portal URL.

​
expires_at
string<date-time> | null

Optional auto-expiry; the sweeper soft-deletes past this date.

​
external_source
string | null

Migration provenance (versa, bubble).

​
external_id
string | null
​
metadata
object

Free-form caller metadata. Default {}.

​
deleted_at
string<date-time> | null
read-only
​
s3_deleted_at
string<date-time> | null
read-only

Set once the sweeper purges S3 bytes.

​
created_at
string<date-time>
read-only