Skip to main content
POST
/
records
Create a record
curl --request POST \
  --url https://rest.breakcold.com/api/v1/records \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "workspace_id",
  "objectTypeSlug": "person",
  "fields": {
    "name": "Ada Lovelace",
    "email": "ada@example.com"
  }
}
'
import requests

url = "https://rest.breakcold.com/api/v1/records"

payload = {
"workspaceId": "workspace_id",
"objectTypeSlug": "person",
"fields": {
"name": "Ada Lovelace",
"email": "ada@example.com"
}
}
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({
workspaceId: 'workspace_id',
objectTypeSlug: 'person',
fields: {name: 'Ada Lovelace', email: 'ada@example.com'}
})
};

fetch('https://rest.breakcold.com/api/v1/records', 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://rest.breakcold.com/api/v1/records",
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([
'workspaceId' => 'workspace_id',
'objectTypeSlug' => 'person',
'fields' => [
'name' => 'Ada Lovelace',
'email' => 'ada@example.com'
]
]),
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://rest.breakcold.com/api/v1/records"

payload := strings.NewReader("{\n \"workspaceId\": \"workspace_id\",\n \"objectTypeSlug\": \"person\",\n \"fields\": {\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\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://rest.breakcold.com/api/v1/records")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"workspace_id\",\n \"objectTypeSlug\": \"person\",\n \"fields\": {\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://rest.breakcold.com/api/v1/records")

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 \"workspaceId\": \"workspace_id\",\n \"objectTypeSlug\": \"person\",\n \"fields\": {\n \"name\": \"Ada Lovelace\",\n \"email\": \"ada@example.com\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "record": {
    "id": "<string>",
    "workspaceId": "<string>",
    "objectTypeId": "<string>",
    "isArchived": true,
    "createdAt": 123,
    "updatedAt": 123,
    "objectTypeSlug": "<string>",
    "displayName": "<string>",
    "fields": {},
    "archivedAt": 123
  }
}
{
"record": {
"id": "<string>",
"workspaceId": "<string>",
"objectTypeId": "<string>",
"isArchived": true,
"createdAt": 123,
"updatedAt": 123,
"objectTypeSlug": "<string>",
"displayName": "<string>",
"fields": {},
"archivedAt": 123
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}

Authorizations

Authorization
string
header
required

Breakcold public API key, for example Bearer bc_live_....

Headers

X-Breakcold-Organization-Id
string

Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token.

Body

application/json
workspaceId
string
required
Minimum string length: 6
objectTypeId
string
Minimum string length: 6
objectTypeSlug
string
fields
object

Map of field slug to value. Values follow the field type: strings for text/social fields, numbers for numeric/date fields, booleans for checkbox, { amount, currencyCode } for currency, { optionId } for select, arrays for multi-value fields. Multiselect fields accept an array of raw option ids or { optionId } objects.

Response

Success

record
object
required