Create a record
curl --request POST \
--url https://api.custral.com/v1/records/{object} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": {
"email": "jane@acme.com",
"full_name": "Jane Doe"
},
"name": "Jane Doe"
}
'import requests
url = "https://api.custral.com/v1/records/{object}"
payload = {
"fields": {
"email": "jane@acme.com",
"full_name": "Jane Doe"
},
"name": "Jane Doe"
}
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({fields: {email: 'jane@acme.com', full_name: 'Jane Doe'}, name: 'Jane Doe'})
};
fetch('https://api.custral.com/v1/records/{object}', 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.custral.com/v1/records/{object}",
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([
'fields' => [
'email' => 'jane@acme.com',
'full_name' => 'Jane Doe'
],
'name' => 'Jane Doe'
]),
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.custral.com/v1/records/{object}"
payload := strings.NewReader("{\n \"fields\": {\n \"email\": \"jane@acme.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"name\": \"Jane Doe\"\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.custral.com/v1/records/{object}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": {\n \"email\": \"jane@acme.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"name\": \"Jane Doe\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custral.com/v1/records/{object}")
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 \"fields\": {\n \"email\": \"jane@acme.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"name\": \"Jane Doe\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "rec_123",
"action": "created",
"ignoredFields": [
"nickname"
]
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "validation_failed"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "invalid_api_key"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "insufficient_scope"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "not_found"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "rate_limited"
},
"reqId": "req_2a1f9c8e7b6d5"
}Records
Create a record
Push a record into an object from a {property: value} map. Requires scope: records:write.
This always adds a new record: there is no upsert. To change an existing record, use PATCH /v1/records/{object}/{id}. Field keys that don’t match a property on the object are dropped and returned in ignoredFields.
POST
/
v1
/
records
/
{object}
Create a record
curl --request POST \
--url https://api.custral.com/v1/records/{object} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"fields": {
"email": "jane@acme.com",
"full_name": "Jane Doe"
},
"name": "Jane Doe"
}
'import requests
url = "https://api.custral.com/v1/records/{object}"
payload = {
"fields": {
"email": "jane@acme.com",
"full_name": "Jane Doe"
},
"name": "Jane Doe"
}
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({fields: {email: 'jane@acme.com', full_name: 'Jane Doe'}, name: 'Jane Doe'})
};
fetch('https://api.custral.com/v1/records/{object}', 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.custral.com/v1/records/{object}",
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([
'fields' => [
'email' => 'jane@acme.com',
'full_name' => 'Jane Doe'
],
'name' => 'Jane Doe'
]),
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.custral.com/v1/records/{object}"
payload := strings.NewReader("{\n \"fields\": {\n \"email\": \"jane@acme.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"name\": \"Jane Doe\"\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.custral.com/v1/records/{object}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": {\n \"email\": \"jane@acme.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"name\": \"Jane Doe\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.custral.com/v1/records/{object}")
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 \"fields\": {\n \"email\": \"jane@acme.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"name\": \"Jane Doe\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "rec_123",
"action": "created",
"ignoredFields": [
"nickname"
]
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "validation_failed"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "invalid_api_key"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "insufficient_scope"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "not_found"
},
"reqId": "req_2a1f9c8e7b6d5"
}{
"error": {
"code": "rate_limited"
},
"reqId": "req_2a1f9c8e7b6d5"
}Authorizations
A Custral secret API key (sk_…), created in Settings → Applications. Sent as Authorization: Bearer sk_…. The X-Api-Key: sk_… header is also accepted and takes precedence. Never expose a secret key in a browser.
Path Parameters
The target object — its id (obj_…), key, or name (e.g. contacts).
Body
application/json
Was this page helpful?