Update a CRM record view
curl --request PATCH \
--url https://rest.breakcold.com/api/v1/crm/views/{viewId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"emoji": "<string>",
"isDefault": true,
"kanbanFieldDefinitionId": "<string>",
"kanbanWinOptionIds": [
"<string>"
],
"kanbanLossOptionIds": [
"<string>"
],
"config": {}
}
'import requests
url = "https://rest.breakcold.com/api/v1/crm/views/{viewId}"
payload = {
"name": "<string>",
"emoji": "<string>",
"isDefault": True,
"kanbanFieldDefinitionId": "<string>",
"kanbanWinOptionIds": ["<string>"],
"kanbanLossOptionIds": ["<string>"],
"config": {}
}
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>',
emoji: '<string>',
isDefault: true,
kanbanFieldDefinitionId: '<string>',
kanbanWinOptionIds: ['<string>'],
kanbanLossOptionIds: ['<string>'],
config: {}
})
};
fetch('https://rest.breakcold.com/api/v1/crm/views/{viewId}', 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/views/{viewId}",
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>',
'emoji' => '<string>',
'isDefault' => true,
'kanbanFieldDefinitionId' => '<string>',
'kanbanWinOptionIds' => [
'<string>'
],
'kanbanLossOptionIds' => [
'<string>'
],
'config' => [
]
]),
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/views/{viewId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"isDefault\": true,\n \"kanbanFieldDefinitionId\": \"<string>\",\n \"kanbanWinOptionIds\": [\n \"<string>\"\n ],\n \"kanbanLossOptionIds\": [\n \"<string>\"\n ],\n \"config\": {}\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/views/{viewId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"isDefault\": true,\n \"kanbanFieldDefinitionId\": \"<string>\",\n \"kanbanWinOptionIds\": [\n \"<string>\"\n ],\n \"kanbanLossOptionIds\": [\n \"<string>\"\n ],\n \"config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.breakcold.com/api/v1/crm/views/{viewId}")
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 \"emoji\": \"<string>\",\n \"isDefault\": true,\n \"kanbanFieldDefinitionId\": \"<string>\",\n \"kanbanWinOptionIds\": [\n \"<string>\"\n ],\n \"kanbanLossOptionIds\": [\n \"<string>\"\n ],\n \"config\": {}\n}"
response = http.request(request)
puts response.read_body{
"view": {
"id": "<string>",
"workspaceId": "<string>",
"objectTypeId": "<string>",
"name": "<string>",
"isDefault": true,
"config": {},
"createdAt": 123,
"updatedAt": 123,
"emoji": "<string>",
"order": 123,
"createdBy": "<string>",
"kanbanFieldDefinitionId": "<string>",
"kanbanWinOptionIds": [
"<string>"
],
"kanbanLossOptionIds": [
"<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
}
}CRM
Update a CRM record view
Update record view metadata and replace the full saved config.
| Token cost | Rate limit |
|---|---|
| 40 tokens | 120 requests/min per route/org |
PATCH
/
crm
/
views
/
{viewId}
Update a CRM record view
curl --request PATCH \
--url https://rest.breakcold.com/api/v1/crm/views/{viewId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"emoji": "<string>",
"isDefault": true,
"kanbanFieldDefinitionId": "<string>",
"kanbanWinOptionIds": [
"<string>"
],
"kanbanLossOptionIds": [
"<string>"
],
"config": {}
}
'import requests
url = "https://rest.breakcold.com/api/v1/crm/views/{viewId}"
payload = {
"name": "<string>",
"emoji": "<string>",
"isDefault": True,
"kanbanFieldDefinitionId": "<string>",
"kanbanWinOptionIds": ["<string>"],
"kanbanLossOptionIds": ["<string>"],
"config": {}
}
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>',
emoji: '<string>',
isDefault: true,
kanbanFieldDefinitionId: '<string>',
kanbanWinOptionIds: ['<string>'],
kanbanLossOptionIds: ['<string>'],
config: {}
})
};
fetch('https://rest.breakcold.com/api/v1/crm/views/{viewId}', 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/views/{viewId}",
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>',
'emoji' => '<string>',
'isDefault' => true,
'kanbanFieldDefinitionId' => '<string>',
'kanbanWinOptionIds' => [
'<string>'
],
'kanbanLossOptionIds' => [
'<string>'
],
'config' => [
]
]),
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/views/{viewId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"isDefault\": true,\n \"kanbanFieldDefinitionId\": \"<string>\",\n \"kanbanWinOptionIds\": [\n \"<string>\"\n ],\n \"kanbanLossOptionIds\": [\n \"<string>\"\n ],\n \"config\": {}\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/views/{viewId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"isDefault\": true,\n \"kanbanFieldDefinitionId\": \"<string>\",\n \"kanbanWinOptionIds\": [\n \"<string>\"\n ],\n \"kanbanLossOptionIds\": [\n \"<string>\"\n ],\n \"config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.breakcold.com/api/v1/crm/views/{viewId}")
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 \"emoji\": \"<string>\",\n \"isDefault\": true,\n \"kanbanFieldDefinitionId\": \"<string>\",\n \"kanbanWinOptionIds\": [\n \"<string>\"\n ],\n \"kanbanLossOptionIds\": [\n \"<string>\"\n ],\n \"config\": {}\n}"
response = http.request(request)
puts response.read_body{
"view": {
"id": "<string>",
"workspaceId": "<string>",
"objectTypeId": "<string>",
"name": "<string>",
"isDefault": true,
"config": {},
"createdAt": 123,
"updatedAt": 123,
"emoji": "<string>",
"order": 123,
"createdBy": "<string>",
"kanbanFieldDefinitionId": "<string>",
"kanbanWinOptionIds": [
"<string>"
],
"kanbanLossOptionIds": [
"<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
ApiKeyBearerBreakcoldOAuth
Breakcold public API key, for example Bearer bc_live_....
Headers
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
Body
application/json
Available options:
table, kanban Minimum string length:
6Minimum string length:
6Minimum string length:
6Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts.
Response
Success
Show child attributes
Show child attributes
Was this page helpful?
⌘I