Create an inbox view
curl --request POST \
--url https://rest.breakcold.com/api/v1/inbox/views \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspaceId": "<string>",
"name": "<string>",
"emoji": "<string>",
"config": {}
}
'import requests
url = "https://rest.breakcold.com/api/v1/inbox/views"
payload = {
"workspaceId": "<string>",
"name": "<string>",
"emoji": "<string>",
"config": {}
}
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: '<string>', name: '<string>', emoji: '<string>', config: {}})
};
fetch('https://rest.breakcold.com/api/v1/inbox/views', 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/inbox/views",
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' => '<string>',
'name' => '<string>',
'emoji' => '<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/inbox/views"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"config\": {}\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/inbox/views")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.breakcold.com/api/v1/inbox/views")
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\": \"<string>\",\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"config\": {}\n}"
response = http.request(request)
puts response.read_body{
"view": {
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"isSystem": true,
"config": {},
"createdAt": 123,
"updatedAt": 123,
"emoji": "<string>",
"systemViewKey": "<string>",
"createdByUserId": "<string>"
}
}{
"view": {
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"isSystem": true,
"config": {},
"createdAt": 123,
"updatedAt": 123,
"emoji": "<string>",
"systemViewKey": "<string>",
"createdByUserId": "<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
}
}Inbox
Create an inbox view
Create an inbox saved view for the effective actor user.
| Token cost | Rate limit |
|---|---|
| 40 tokens | 120 requests/min per route/org |
POST
/
inbox
/
views
Create an inbox view
curl --request POST \
--url https://rest.breakcold.com/api/v1/inbox/views \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"workspaceId": "<string>",
"name": "<string>",
"emoji": "<string>",
"config": {}
}
'import requests
url = "https://rest.breakcold.com/api/v1/inbox/views"
payload = {
"workspaceId": "<string>",
"name": "<string>",
"emoji": "<string>",
"config": {}
}
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: '<string>', name: '<string>', emoji: '<string>', config: {}})
};
fetch('https://rest.breakcold.com/api/v1/inbox/views', 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/inbox/views",
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' => '<string>',
'name' => '<string>',
'emoji' => '<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/inbox/views"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"config\": {}\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/inbox/views")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"config\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.breakcold.com/api/v1/inbox/views")
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\": \"<string>\",\n \"name\": \"<string>\",\n \"emoji\": \"<string>\",\n \"config\": {}\n}"
response = http.request(request)
puts response.read_body{
"view": {
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"isSystem": true,
"config": {},
"createdAt": 123,
"updatedAt": 123,
"emoji": "<string>",
"systemViewKey": "<string>",
"createdByUserId": "<string>"
}
}{
"view": {
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"isSystem": true,
"config": {},
"createdAt": 123,
"updatedAt": 123,
"emoji": "<string>",
"systemViewKey": "<string>",
"createdByUserId": "<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.
Body
application/json
Minimum string length:
6Available options:
personal, workspace, restricted Full 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