curl --request POST \
--url https://production-api.joinrings.com/v1/notes/batch \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"notes": [
{
"subject": "<string>",
"associations": [
{
"entity_type": "<string>",
"entity_uuid": "<string>"
}
],
"content": "<string>",
"date": 123,
"idempotency_key": "<string>",
"mentions": [
{
"type": "<string>",
"uuid": "<string>"
}
],
"owner_user_uuid": "<string>"
}
]
}
'import requests
url = "https://production-api.joinrings.com/v1/notes/batch"
payload = { "notes": [
{
"subject": "<string>",
"associations": [
{
"entity_type": "<string>",
"entity_uuid": "<string>"
}
],
"content": "<string>",
"date": 123,
"idempotency_key": "<string>",
"mentions": [
{
"type": "<string>",
"uuid": "<string>"
}
],
"owner_user_uuid": "<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({
notes: [
{
subject: '<string>',
associations: [{entity_type: '<string>', entity_uuid: '<string>'}],
content: '<string>',
date: 123,
idempotency_key: '<string>',
mentions: [{type: '<string>', uuid: '<string>'}],
owner_user_uuid: '<string>'
}
]
})
};
fetch('https://production-api.joinrings.com/v1/notes/batch', 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://production-api.joinrings.com/v1/notes/batch",
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([
'notes' => [
[
'subject' => '<string>',
'associations' => [
[
'entity_type' => '<string>',
'entity_uuid' => '<string>'
]
],
'content' => '<string>',
'date' => 123,
'idempotency_key' => '<string>',
'mentions' => [
[
'type' => '<string>',
'uuid' => '<string>'
]
],
'owner_user_uuid' => '<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://production-api.joinrings.com/v1/notes/batch"
payload := strings.NewReader("{\n \"notes\": [\n {\n \"subject\": \"<string>\",\n \"associations\": [\n {\n \"entity_type\": \"<string>\",\n \"entity_uuid\": \"<string>\"\n }\n ],\n \"content\": \"<string>\",\n \"date\": 123,\n \"idempotency_key\": \"<string>\",\n \"mentions\": [\n {\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"owner_user_uuid\": \"<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://production-api.joinrings.com/v1/notes/batch")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"notes\": [\n {\n \"subject\": \"<string>\",\n \"associations\": [\n {\n \"entity_type\": \"<string>\",\n \"entity_uuid\": \"<string>\"\n }\n ],\n \"content\": \"<string>\",\n \"date\": 123,\n \"idempotency_key\": \"<string>\",\n \"mentions\": [\n {\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"owner_user_uuid\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/notes/batch")
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 \"notes\": [\n {\n \"subject\": \"<string>\",\n \"associations\": [\n {\n \"entity_type\": \"<string>\",\n \"entity_uuid\": \"<string>\"\n }\n ],\n \"content\": \"<string>\",\n \"date\": 123,\n \"idempotency_key\": \"<string>\",\n \"mentions\": [\n {\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"owner_user_uuid\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"index": 123,
"status": "<string>",
"error": "<string>",
"uuid": "<string>"
}
]
}Batch create notes
associations and optional per-note idempotency.
Each entry is created independently using the same path as POST /v1/notes
(full body to S3, excerpt + owner + inline associations on the row). A
single failing row comes back as status ERROR without sinking the rest of
the batch; results are returned in input order.
Supplying idempotency_key per note makes the import safely re-runnable:
re-submitting the same key returns the existing note (status SKIPPED)
instead of creating a duplicate. This is the note half of the bulk import
flow — create the people first via POST /v1/persons/batch, then attach
their notes here.
A person/company created moments earlier may not yet be visible to this
endpoint (writes go to DynamoDB and sync to the read store asynchronously).
If a note’s association can’t be resolved, that note is NOT created and is
returned with status ERROR and a retryable message — wait briefly for the
entity to sync, then re-submit the same idempotency_key.
curl --request POST \
--url https://production-api.joinrings.com/v1/notes/batch \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"notes": [
{
"subject": "<string>",
"associations": [
{
"entity_type": "<string>",
"entity_uuid": "<string>"
}
],
"content": "<string>",
"date": 123,
"idempotency_key": "<string>",
"mentions": [
{
"type": "<string>",
"uuid": "<string>"
}
],
"owner_user_uuid": "<string>"
}
]
}
'import requests
url = "https://production-api.joinrings.com/v1/notes/batch"
payload = { "notes": [
{
"subject": "<string>",
"associations": [
{
"entity_type": "<string>",
"entity_uuid": "<string>"
}
],
"content": "<string>",
"date": 123,
"idempotency_key": "<string>",
"mentions": [
{
"type": "<string>",
"uuid": "<string>"
}
],
"owner_user_uuid": "<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({
notes: [
{
subject: '<string>',
associations: [{entity_type: '<string>', entity_uuid: '<string>'}],
content: '<string>',
date: 123,
idempotency_key: '<string>',
mentions: [{type: '<string>', uuid: '<string>'}],
owner_user_uuid: '<string>'
}
]
})
};
fetch('https://production-api.joinrings.com/v1/notes/batch', 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://production-api.joinrings.com/v1/notes/batch",
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([
'notes' => [
[
'subject' => '<string>',
'associations' => [
[
'entity_type' => '<string>',
'entity_uuid' => '<string>'
]
],
'content' => '<string>',
'date' => 123,
'idempotency_key' => '<string>',
'mentions' => [
[
'type' => '<string>',
'uuid' => '<string>'
]
],
'owner_user_uuid' => '<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://production-api.joinrings.com/v1/notes/batch"
payload := strings.NewReader("{\n \"notes\": [\n {\n \"subject\": \"<string>\",\n \"associations\": [\n {\n \"entity_type\": \"<string>\",\n \"entity_uuid\": \"<string>\"\n }\n ],\n \"content\": \"<string>\",\n \"date\": 123,\n \"idempotency_key\": \"<string>\",\n \"mentions\": [\n {\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"owner_user_uuid\": \"<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://production-api.joinrings.com/v1/notes/batch")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"notes\": [\n {\n \"subject\": \"<string>\",\n \"associations\": [\n {\n \"entity_type\": \"<string>\",\n \"entity_uuid\": \"<string>\"\n }\n ],\n \"content\": \"<string>\",\n \"date\": 123,\n \"idempotency_key\": \"<string>\",\n \"mentions\": [\n {\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"owner_user_uuid\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.joinrings.com/v1/notes/batch")
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 \"notes\": [\n {\n \"subject\": \"<string>\",\n \"associations\": [\n {\n \"entity_type\": \"<string>\",\n \"entity_uuid\": \"<string>\"\n }\n ],\n \"content\": \"<string>\",\n \"date\": 123,\n \"idempotency_key\": \"<string>\",\n \"mentions\": [\n {\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"owner_user_uuid\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"index": 123,
"status": "<string>",
"error": "<string>",
"uuid": "<string>"
}
]
}