Skip to main content
PATCH
/
crm
/
fields
/
{fieldDefinitionId}
Update a CRM field
curl --request PATCH \
  --url https://rest.breakcold.com/api/v1/crm/fields/{fieldDefinitionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "isRequired": true,
  "isHidden": true,
  "isMultiple": true,
  "showInCreateModal": true,
  "defaultValue": "<unknown>",
  "validation": {},
  "targetObjectTypeId": "<string>",
  "notifyOnAssign": true,
  "interactionRollupMode": "<string>",
  "defaultValueTemplate": "<string>",
  "isComputed": true,
  "computeExpression": "<string>",
  "isIdentifier": true
}
'
import requests

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

payload = {
"name": "<string>",
"description": "<string>",
"isRequired": True,
"isHidden": True,
"isMultiple": True,
"showInCreateModal": True,
"defaultValue": "<unknown>",
"validation": {},
"targetObjectTypeId": "<string>",
"notifyOnAssign": True,
"interactionRollupMode": "<string>",
"defaultValueTemplate": "<string>",
"isComputed": True,
"computeExpression": "<string>",
"isIdentifier": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
isRequired: true,
isHidden: true,
isMultiple: true,
showInCreateModal: true,
defaultValue: '<unknown>',
validation: {},
targetObjectTypeId: '<string>',
notifyOnAssign: true,
interactionRollupMode: '<string>',
defaultValueTemplate: '<string>',
isComputed: true,
computeExpression: '<string>',
isIdentifier: true
})
};

fetch('https://rest.breakcold.com/api/v1/crm/fields/{fieldDefinitionId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'isRequired' => true,
'isHidden' => true,
'isMultiple' => true,
'showInCreateModal' => true,
'defaultValue' => '<unknown>',
'validation' => [

],
'targetObjectTypeId' => '<string>',
'notifyOnAssign' => true,
'interactionRollupMode' => '<string>',
'defaultValueTemplate' => '<string>',
'isComputed' => true,
'computeExpression' => '<string>',
'isIdentifier' => 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}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isRequired\": true,\n \"isHidden\": true,\n \"isMultiple\": true,\n \"showInCreateModal\": true,\n \"defaultValue\": \"<unknown>\",\n \"validation\": {},\n \"targetObjectTypeId\": \"<string>\",\n \"notifyOnAssign\": true,\n \"interactionRollupMode\": \"<string>\",\n \"defaultValueTemplate\": \"<string>\",\n \"isComputed\": true,\n \"computeExpression\": \"<string>\",\n \"isIdentifier\": true\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://rest.breakcold.com/api/v1/crm/fields/{fieldDefinitionId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isRequired\": true,\n \"isHidden\": true,\n \"isMultiple\": true,\n \"showInCreateModal\": true,\n \"defaultValue\": \"<unknown>\",\n \"validation\": {},\n \"targetObjectTypeId\": \"<string>\",\n \"notifyOnAssign\": true,\n \"interactionRollupMode\": \"<string>\",\n \"defaultValueTemplate\": \"<string>\",\n \"isComputed\": true,\n \"computeExpression\": \"<string>\",\n \"isIdentifier\": true\n}")
.asString();
require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"isRequired\": true,\n \"isHidden\": true,\n \"isMultiple\": true,\n \"showInCreateModal\": true,\n \"defaultValue\": \"<unknown>\",\n \"validation\": {},\n \"targetObjectTypeId\": \"<string>\",\n \"notifyOnAssign\": true,\n \"interactionRollupMode\": \"<string>\",\n \"defaultValueTemplate\": \"<string>\",\n \"isComputed\": true,\n \"computeExpression\": \"<string>\",\n \"isIdentifier\": true\n}"

response = http.request(request)
puts response.read_body
{
  "field": {
    "id": "<string>",
    "workspaceId": "<string>",
    "objectTypeId": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "fieldType": "<string>",
    "isSystem": true,
    "isRequired": true,
    "isHidden": true,
    "isMultiple": true,
    "isPrimary": true,
    "order": 123,
    "createdAt": 123,
    "updatedAt": 123,
    "description": "<string>",
    "isReadOnly": true,
    "showInCreateModal": true,
    "defaultValue": "<unknown>",
    "validation": {},
    "targetObjectTypeId": "<string>",
    "relationDefinitionId": "<string>",
    "notifyOnAssign": true,
    "defaultValueTemplate": "<string>",
    "isComputed": true,
    "computeExpression": "<string>",
    "isIdentifier": true
  }
}
{
"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
name
string
description
string
isRequired
boolean
isHidden
boolean
isMultiple
boolean
showInCreateModal
boolean
defaultValue
any
validation
object
targetObjectTypeId
string
Minimum string length: 6
notifyOnAssign
boolean
interactionRollupMode
string
defaultValueTemplate
string
isComputed
boolean
computeExpression
string
isIdentifier
boolean

Response

Success

field
object
required