Skip to main content
POST
/
crm
/
fields
/
{fieldDefinitionId}
/
options
Create a CRM field option
curl --request POST \
  --url https://rest.breakcold.com/api/v1/crm/fields/{fieldDefinitionId}/options \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>",
  "label": "<string>",
  "color": "<string>",
  "isDefault": true,
  "isActive": true
}
'
import requests

url = "https://rest.breakcold.com/api/v1/crm/fields/{fieldDefinitionId}/options"

payload = {
"value": "<string>",
"label": "<string>",
"color": "<string>",
"isDefault": True,
"isActive": True
}
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({
value: '<string>',
label: '<string>',
color: '<string>',
isDefault: true,
isActive: true
})
};

fetch('https://rest.breakcold.com/api/v1/crm/fields/{fieldDefinitionId}/options', 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/crm/fields/{fieldDefinitionId}/options",
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([
'value' => '<string>',
'label' => '<string>',
'color' => '<string>',
'isDefault' => true,
'isActive' => true
]),
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/crm/fields/{fieldDefinitionId}/options"

payload := strings.NewReader("{\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"color\": \"<string>\",\n \"isDefault\": true,\n \"isActive\": true\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/crm/fields/{fieldDefinitionId}/options")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"color\": \"<string>\",\n \"isDefault\": true,\n \"isActive\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://rest.breakcold.com/api/v1/crm/fields/{fieldDefinitionId}/options")

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 \"value\": \"<string>\",\n \"label\": \"<string>\",\n \"color\": \"<string>\",\n \"isDefault\": true,\n \"isActive\": true\n}"

response = http.request(request)
puts response.read_body
{
  "option": {
    "id": "<string>",
    "fieldDefinitionId": "<string>",
    "value": "<string>",
    "label": "<string>",
    "order": 123,
    "isDefault": true,
    "isActive": true,
    "color": "<string>"
  }
}
{
"option": {
"id": "<string>",
"fieldDefinitionId": "<string>",
"value": "<string>",
"label": "<string>",
"order": 123,
"isDefault": true,
"isActive": true,
"color": "<string>"
}
}
{
"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.

Path Parameters

fieldDefinitionId
string
required

Body

application/json
value
string
required
label
string
required
color
string
isDefault
boolean
isActive
boolean

Response

Success

option
object
required