Create or update catalog records by external id
curl --request POST \
--url https://api.ciarem.ai/v1/catalogs/{catalog_id}/records/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"records": [
{
"external_id": "<string>",
"name": "<string>",
"properties": {}
}
]
}
'import requests
url = "https://api.ciarem.ai/v1/catalogs/{catalog_id}/records/batch"
payload = { "records": [
{
"external_id": "<string>",
"name": "<string>",
"properties": {}
}
] }
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({records: [{external_id: '<string>', name: '<string>', properties: {}}]})
};
fetch('https://api.ciarem.ai/v1/catalogs/{catalog_id}/records/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://api.ciarem.ai/v1/catalogs/{catalog_id}/records/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([
'records' => [
[
'external_id' => '<string>',
'name' => '<string>',
'properties' => [
]
]
]
]),
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.ciarem.ai/v1/catalogs/{catalog_id}/records/batch"
payload := strings.NewReader("{\n \"records\": [\n {\n \"external_id\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {}\n }\n ]\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.ciarem.ai/v1/catalogs/{catalog_id}/records/batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"records\": [\n {\n \"external_id\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ciarem.ai/v1/catalogs/{catalog_id}/records/batch")
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 \"records\": [\n {\n \"external_id\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"created": 123,
"updated": 123,
"failed": 123,
"results": [
{
"external_id": "<string>",
"id": "<string>",
"status": "created",
"error": {
"code": "duplicate_in_file",
"field": "<string>",
"message": "<string>"
}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}Catalogs
Create or update catalog records by external id
Up to 100 records. A row whose external_id is already in the catalog updates that record (a property left out is untouched, a null clears it); any other row creates one and needs name. Each row succeeds or fails on its own: the answer is 200 with one result per row, in request order. An external_id on two rows of the request fails both. Records created here produce one catalog.records.bulk_created webhook, not one per record. A property’s value_datetime is ISO 8601. Without an offset (2026-11-10T15:00) it is read in the organization’s time zone, or UTC when none is set.
POST
/
v1
/
catalogs
/
{catalog_id}
/
records
/
batch
Create or update catalog records by external id
curl --request POST \
--url https://api.ciarem.ai/v1/catalogs/{catalog_id}/records/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"records": [
{
"external_id": "<string>",
"name": "<string>",
"properties": {}
}
]
}
'import requests
url = "https://api.ciarem.ai/v1/catalogs/{catalog_id}/records/batch"
payload = { "records": [
{
"external_id": "<string>",
"name": "<string>",
"properties": {}
}
] }
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({records: [{external_id: '<string>', name: '<string>', properties: {}}]})
};
fetch('https://api.ciarem.ai/v1/catalogs/{catalog_id}/records/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://api.ciarem.ai/v1/catalogs/{catalog_id}/records/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([
'records' => [
[
'external_id' => '<string>',
'name' => '<string>',
'properties' => [
]
]
]
]),
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.ciarem.ai/v1/catalogs/{catalog_id}/records/batch"
payload := strings.NewReader("{\n \"records\": [\n {\n \"external_id\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {}\n }\n ]\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.ciarem.ai/v1/catalogs/{catalog_id}/records/batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"records\": [\n {\n \"external_id\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ciarem.ai/v1/catalogs/{catalog_id}/records/batch")
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 \"records\": [\n {\n \"external_id\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"created": 123,
"updated": 123,
"failed": 123,
"results": [
{
"external_id": "<string>",
"id": "<string>",
"status": "created",
"error": {
"code": "duplicate_in_file",
"field": "<string>",
"message": "<string>"
}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}Body
application/json