Lists
Update a list
PATCH
/
lists
/
{id}
Update a list
curl --request PATCH \
--url https://api.breakcold.com/rest/lists/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"emoji": "<string>",
"schema": "<unknown>",
"attribute_definitions_order": [
"<string>"
],
"ai_instructions": "<unknown>",
"ai_instructions_text": "<string>",
"ai_rules": "<unknown>",
"ai_rules_text": "<string>",
"ai_enabled": true
}
'import requests
url = "https://api.breakcold.com/rest/lists/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"emoji": "<string>",
"schema": "<unknown>",
"attribute_definitions_order": ["<string>"],
"ai_instructions": "<unknown>",
"ai_instructions_text": "<string>",
"ai_rules": "<unknown>",
"ai_rules_text": "<string>",
"ai_enabled": True
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
emoji: '<string>',
schema: '<unknown>',
attribute_definitions_order: ['<string>'],
ai_instructions: '<unknown>',
ai_instructions_text: '<string>',
ai_rules: '<unknown>',
ai_rules_text: '<string>',
ai_enabled: true
})
};
fetch('https://api.breakcold.com/rest/lists/{id}', 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://api.breakcold.com/rest/lists/{id}",
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>',
'emoji' => '<string>',
'schema' => '<unknown>',
'attribute_definitions_order' => [
'<string>'
],
'ai_instructions' => '<unknown>',
'ai_instructions_text' => '<string>',
'ai_rules' => '<unknown>',
'ai_rules_text' => '<string>',
'ai_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://api.breakcold.com/rest/lists/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"emoji\": \"<string>\",\n \"schema\": \"<unknown>\",\n \"attribute_definitions_order\": [\n \"<string>\"\n ],\n \"ai_instructions\": \"<unknown>\",\n \"ai_instructions_text\": \"<string>\",\n \"ai_rules\": \"<unknown>\",\n \"ai_rules_text\": \"<string>\",\n \"ai_enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://api.breakcold.com/rest/lists/{id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"emoji\": \"<string>\",\n \"schema\": \"<unknown>\",\n \"attribute_definitions_order\": [\n \"<string>\"\n ],\n \"ai_instructions\": \"<unknown>\",\n \"ai_instructions_text\": \"<string>\",\n \"ai_rules\": \"<unknown>\",\n \"ai_rules_text\": \"<string>\",\n \"ai_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.breakcold.com/rest/lists/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"emoji\": \"<string>\",\n \"schema\": \"<unknown>\",\n \"attribute_definitions_order\": [\n \"<string>\"\n ],\n \"ai_instructions\": \"<unknown>\",\n \"ai_instructions_text\": \"<string>\",\n \"ai_rules\": \"<unknown>\",\n \"ai_rules_text\": \"<string>\",\n \"ai_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"order": 123,
"emoji": "<string>",
"description": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"can_be_delete": true,
"deleted_at": "<string>",
"is_deleted": true,
"favorite": true,
"id_space": "<string>",
"attribute_definitions_order": [
"<string>"
],
"ai_instructions": null,
"ai_rules": null,
"ai_instructions_text": "<string>",
"ai_rules_text": "<string>",
"ai_enabled": true
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Authorizations
Path Parameters
Body
application/json
Response
Successful response
Was this page helpful?
⌘I
Update a list
curl --request PATCH \
--url https://api.breakcold.com/rest/lists/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"emoji": "<string>",
"schema": "<unknown>",
"attribute_definitions_order": [
"<string>"
],
"ai_instructions": "<unknown>",
"ai_instructions_text": "<string>",
"ai_rules": "<unknown>",
"ai_rules_text": "<string>",
"ai_enabled": true
}
'import requests
url = "https://api.breakcold.com/rest/lists/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"emoji": "<string>",
"schema": "<unknown>",
"attribute_definitions_order": ["<string>"],
"ai_instructions": "<unknown>",
"ai_instructions_text": "<string>",
"ai_rules": "<unknown>",
"ai_rules_text": "<string>",
"ai_enabled": True
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
emoji: '<string>',
schema: '<unknown>',
attribute_definitions_order: ['<string>'],
ai_instructions: '<unknown>',
ai_instructions_text: '<string>',
ai_rules: '<unknown>',
ai_rules_text: '<string>',
ai_enabled: true
})
};
fetch('https://api.breakcold.com/rest/lists/{id}', 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://api.breakcold.com/rest/lists/{id}",
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>',
'emoji' => '<string>',
'schema' => '<unknown>',
'attribute_definitions_order' => [
'<string>'
],
'ai_instructions' => '<unknown>',
'ai_instructions_text' => '<string>',
'ai_rules' => '<unknown>',
'ai_rules_text' => '<string>',
'ai_enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://api.breakcold.com/rest/lists/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"emoji\": \"<string>\",\n \"schema\": \"<unknown>\",\n \"attribute_definitions_order\": [\n \"<string>\"\n ],\n \"ai_instructions\": \"<unknown>\",\n \"ai_instructions_text\": \"<string>\",\n \"ai_rules\": \"<unknown>\",\n \"ai_rules_text\": \"<string>\",\n \"ai_enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://api.breakcold.com/rest/lists/{id}")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"emoji\": \"<string>\",\n \"schema\": \"<unknown>\",\n \"attribute_definitions_order\": [\n \"<string>\"\n ],\n \"ai_instructions\": \"<unknown>\",\n \"ai_instructions_text\": \"<string>\",\n \"ai_rules\": \"<unknown>\",\n \"ai_rules_text\": \"<string>\",\n \"ai_enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.breakcold.com/rest/lists/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"emoji\": \"<string>\",\n \"schema\": \"<unknown>\",\n \"attribute_definitions_order\": [\n \"<string>\"\n ],\n \"ai_instructions\": \"<unknown>\",\n \"ai_instructions_text\": \"<string>\",\n \"ai_rules\": \"<unknown>\",\n \"ai_rules_text\": \"<string>\",\n \"ai_enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"order": 123,
"emoji": "<string>",
"description": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"can_be_delete": true,
"deleted_at": "<string>",
"is_deleted": true,
"favorite": true,
"id_space": "<string>",
"attribute_definitions_order": [
"<string>"
],
"ai_instructions": null,
"ai_rules": null,
"ai_instructions_text": "<string>",
"ai_rules_text": "<string>",
"ai_enabled": true
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}