curl --request POST \
--url https://api.ciarem.ai/v1/properties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"options": [
{
"key": "<string>",
"label": "<string>"
}
],
"required": false
}
'import requests
url = "https://api.ciarem.ai/v1/properties"
payload = {
"key": "<string>",
"label": "<string>",
"description": "<string>",
"options": [
{
"key": "<string>",
"label": "<string>"
}
],
"required": False
}
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({
key: '<string>',
label: '<string>',
description: '<string>',
options: [{key: '<string>', label: '<string>'}],
required: false
})
};
fetch('https://api.ciarem.ai/v1/properties', 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/properties",
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([
'key' => '<string>',
'label' => '<string>',
'description' => '<string>',
'options' => [
[
'key' => '<string>',
'label' => '<string>'
]
],
'required' => false
]),
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/properties"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"options\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"required\": false\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/properties")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"options\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"required\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ciarem.ai/v1/properties")
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 \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"options\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"required\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"key": "<string>",
"label": "<string>",
"description": "<string>",
"kind": "TEXT",
"options": [
{
"key": "<string>",
"label": "<string>"
}
],
"currency": "AED",
"required": true,
"order_idx": 123,
"archived_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": {
"code": "<string>",
"key": "<string>",
"id": "<string>",
"missing_ids": [
"<string>"
]
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": {
"code": "<string>",
"key": "<string>",
"id": "<string>",
"missing_ids": [
"<string>"
]
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}Create a custom property
curl --request POST \
--url https://api.ciarem.ai/v1/properties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"options": [
{
"key": "<string>",
"label": "<string>"
}
],
"required": false
}
'import requests
url = "https://api.ciarem.ai/v1/properties"
payload = {
"key": "<string>",
"label": "<string>",
"description": "<string>",
"options": [
{
"key": "<string>",
"label": "<string>"
}
],
"required": False
}
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({
key: '<string>',
label: '<string>',
description: '<string>',
options: [{key: '<string>', label: '<string>'}],
required: false
})
};
fetch('https://api.ciarem.ai/v1/properties', 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/properties",
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([
'key' => '<string>',
'label' => '<string>',
'description' => '<string>',
'options' => [
[
'key' => '<string>',
'label' => '<string>'
]
],
'required' => false
]),
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/properties"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"options\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"required\": false\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/properties")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"options\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"required\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ciarem.ai/v1/properties")
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 \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"description\": \"<string>\",\n \"options\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"required\": false\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"key": "<string>",
"label": "<string>",
"description": "<string>",
"kind": "TEXT",
"options": [
{
"key": "<string>",
"label": "<string>"
}
],
"currency": "AED",
"required": true,
"order_idx": 123,
"archived_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"detail": {
"code": "<string>",
"key": "<string>",
"id": "<string>",
"missing_ids": [
"<string>"
]
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": {
"code": "<string>",
"key": "<string>",
"id": "<string>",
"missing_ids": [
"<string>"
]
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}Authorizations
An org API key: Authorization: Bearer oak_….
Body
11Type of a user-defined custom property on a contact.
The order mirrors the Postgres crm_property_kind_enum: TEXTAREA was
appended in 0014 (alongside MULTI_SELECT), EMAIL and MONEY in 0025, FILE
in 0065, URL in 0167, MULTI_FILE in 0186. EMAIL and URL store into
value_text (like TEXT) and MONEY into value_number (like NUMBER) —
they're presentation/validation refinements of those base columns, not new
storage shapes. FILE and MULTI_FILE both store an array of S3 file
references in value_json (see ciarem_crm.file_property); they differ
only in cardinality — FILE holds at most one file, MULTI_FILE a capped
gallery. Pre-0186, FILE meant the gallery; 0186 renamed those rows to
MULTI_FILE and repurposed FILE as the single-file kind (it was
catalogs-only, so no contact data existed). The bytes live in the
record-media bucket.
TEXT, NUMBER, RADIO, DROPDOWN, BOOLEAN, DATE, TEXTAREA, MULTI_SELECT, EMAIL, MONEY, FILE, URL, MULTI_FILE 150Show child attributes
Show child attributes
ISO 4217 alpha code of a circulating currency.
The denomination of a MONEY property definition. Active circulating codes only — the fund/metal/testing X-codes (XAU, XDR, XTS, XXX, …) are excluded, while the circulating X-currencies (XAF, XOF, XPF, XCD) stay. Stored as TEXT (no Postgres enum): the set is ISO's, not ours, and codes retire/appear with currency reforms (SLL→SLE, ZWL→ZWG) — validation lives at the API boundary where it can evolve without a migration.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWG Response
Successful Response
Type of a user-defined custom property on a contact.
The order mirrors the Postgres crm_property_kind_enum: TEXTAREA was
appended in 0014 (alongside MULTI_SELECT), EMAIL and MONEY in 0025, FILE
in 0065, URL in 0167, MULTI_FILE in 0186. EMAIL and URL store into
value_text (like TEXT) and MONEY into value_number (like NUMBER) —
they're presentation/validation refinements of those base columns, not new
storage shapes. FILE and MULTI_FILE both store an array of S3 file
references in value_json (see ciarem_crm.file_property); they differ
only in cardinality — FILE holds at most one file, MULTI_FILE a capped
gallery. Pre-0186, FILE meant the gallery; 0186 renamed those rows to
MULTI_FILE and repurposed FILE as the single-file kind (it was
catalogs-only, so no contact data existed). The bytes live in the
record-media bucket.
TEXT, NUMBER, RADIO, DROPDOWN, BOOLEAN, DATE, TEXTAREA, MULTI_SELECT, EMAIL, MONEY, FILE, URL, MULTI_FILE Show child attributes
Show child attributes
ISO 4217 alpha code of a circulating currency.
The denomination of a MONEY property definition. Active circulating codes only — the fund/metal/testing X-codes (XAU, XDR, XTS, XXX, …) are excluded, while the circulating X-currencies (XAF, XOF, XPF, XCD) stay. Stored as TEXT (no Postgres enum): the set is ISO's, not ours, and codes retire/appear with currency reforms (SLL→SLE, ZWL→ZWG) — validation lives at the API boundary where it can evolve without a migration.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWG