Atualizar campo personalizado
Em um campo do sistema, a chave, a aplicação e o tipo são ignorados. Só o nome, a descrição e o grupo podem ser alterados.
curl --request PUT \
--url https://api.connectadesk.com/api/v1/custom-fields/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Plano",
"key": "plano",
"description": "<string>",
"groupName": "Comercial",
"isPublic": true,
"alwaysVisible": false,
"options": [
{
"name": "Plano",
"color": "#6941C6"
}
]
}
'import requests
url = "https://api.connectadesk.com/api/v1/custom-fields/{id}"
payload = {
"name": "Plano",
"key": "plano",
"description": "<string>",
"groupName": "Comercial",
"isPublic": True,
"alwaysVisible": False,
"options": [
{
"name": "Plano",
"color": "#6941C6"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Plano',
key: 'plano',
description: '<string>',
groupName: 'Comercial',
isPublic: true,
alwaysVisible: false,
options: [{name: 'Plano', color: '#6941C6'}]
})
};
fetch('https://api.connectadesk.com/api/v1/custom-fields/{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.connectadesk.com/api/v1/custom-fields/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Plano',
'key' => 'plano',
'description' => '<string>',
'groupName' => 'Comercial',
'isPublic' => true,
'alwaysVisible' => false,
'options' => [
[
'name' => 'Plano',
'color' => '#6941C6'
]
]
]),
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://api.connectadesk.com/api/v1/custom-fields/{id}"
payload := strings.NewReader("{\n \"name\": \"Plano\",\n \"key\": \"plano\",\n \"description\": \"<string>\",\n \"groupName\": \"Comercial\",\n \"isPublic\": true,\n \"alwaysVisible\": false,\n \"options\": [\n {\n \"name\": \"Plano\",\n \"color\": \"#6941C6\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.connectadesk.com/api/v1/custom-fields/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Plano\",\n \"key\": \"plano\",\n \"description\": \"<string>\",\n \"groupName\": \"Comercial\",\n \"isPublic\": true,\n \"alwaysVisible\": false,\n \"options\": [\n {\n \"name\": \"Plano\",\n \"color\": \"#6941C6\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectadesk.com/api/v1/custom-fields/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Plano\",\n \"key\": \"plano\",\n \"description\": \"<string>\",\n \"groupName\": \"Comercial\",\n \"isPublic\": true,\n \"alwaysVisible\": false,\n \"options\": [\n {\n \"name\": \"Plano\",\n \"color\": \"#6941C6\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 44,
"key": "tipo_de_cliente",
"name": "Tipo de cliente",
"description": "Classificação comercial usada na régua de atendimento.",
"application": "contact",
"type": "select",
"groupName": "Comercial",
"isPublic": true,
"alwaysVisible": true,
"isSystem": false,
"order": 2,
"options": [
{
"id": 91,
"name": "Varejo",
"color": "#0E7490",
"order": 0
},
{
"id": 92,
"name": "Atacado",
"color": "#6941C6",
"order": 1
}
],
"createdAt": "2026-06-09T09:30:00.000Z",
"updatedAt": "2026-08-14T16:05:00.000Z"
}
}{
"error": {
"code": "ERR_API_VALIDATION",
"message": "O campo `number` é obrigatório."
}
}{
"error": {
"code": "ERR_API_UNAUTHORIZED",
"message": "Token de API ausente ou inválido."
}
}{
"error": {
"code": "ERR_API_FORBIDDEN_SCOPE",
"message": "O token não tem permissão para este método neste módulo. A mensagem real nomeia os dois."
}
}{
"error": {
"code": "ERR_API_NOT_FOUND",
"message": "Registro não encontrado."
}
}{
"error": {
"code": "ERR_API_IDEMPOTENCY_KEY_REUSED",
"message": "Idempotency-Key já usada com um corpo diferente."
}
}{
"error": {
"code": "ERR_API_VALIDATION",
"message": "O parâmetro `application` é obrigatório e aceita \"contact\" ou \"card\"."
}
}Autorizações
Token da API no formato sk_live_….
Parâmetros de caminho
Corpo
Nome exibido.
60"Plano"
Onde o campo se aplica: contact em contatos, card em cards do CRM.
contact, card Tipo de valor aceito. Ele define a validação feita a cada gravação:
| valor | aceita |
|---|---|
text | Texto curto, de uma linha. |
number | Número. |
currency | Valor monetário. |
date | Data. |
select | Uma das opções cadastradas no próprio campo. |
boolean | Sim ou não. |
email | E-mail, com o formato validado. |
phone | Telefone. |
link | URL. |
textarea | Texto longo, de várias linhas. |
text, number, currency, date, select, boolean, email, phone, link, textarea Se você não informar, a chave é gerada a partir do nome, em minusculas_com_underline.
40"plano"
Descrição do campo personalizado.
120Grupo do campo no formulário. Campos do mesmo grupo aparecem juntos.
"Comercial"
Deixa o campo visível para todos os atendentes. Quando falso, só quem tem permissão vê o campo.
Mostra o campo na ficha mesmo sem valor preenchido.
Lista de opções. Obrigatória quando type é select.
Show child attributes
Show child attributes
Resposta
OK
Show child attributes
Show child attributes
{
"id": 44,
"key": "tipo_de_cliente",
"name": "Tipo de cliente",
"description": "Classificação comercial usada na régua de atendimento.",
"application": "contact",
"type": "select",
"groupName": "Comercial",
"isPublic": true,
"alwaysVisible": true,
"isSystem": false,
"order": 2,
"options": [
{
"id": 91,
"name": "Varejo",
"color": "#0E7490",
"order": 0
},
{
"id": 92,
"name": "Atacado",
"color": "#6941C6",
"order": 1
}
],
"createdAt": "2026-06-09T09:30:00.000Z",
"updatedAt": "2026-08-14T16:05:00.000Z"
}
curl --request PUT \
--url https://api.connectadesk.com/api/v1/custom-fields/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Plano",
"key": "plano",
"description": "<string>",
"groupName": "Comercial",
"isPublic": true,
"alwaysVisible": false,
"options": [
{
"name": "Plano",
"color": "#6941C6"
}
]
}
'import requests
url = "https://api.connectadesk.com/api/v1/custom-fields/{id}"
payload = {
"name": "Plano",
"key": "plano",
"description": "<string>",
"groupName": "Comercial",
"isPublic": True,
"alwaysVisible": False,
"options": [
{
"name": "Plano",
"color": "#6941C6"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Plano',
key: 'plano',
description: '<string>',
groupName: 'Comercial',
isPublic: true,
alwaysVisible: false,
options: [{name: 'Plano', color: '#6941C6'}]
})
};
fetch('https://api.connectadesk.com/api/v1/custom-fields/{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.connectadesk.com/api/v1/custom-fields/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Plano',
'key' => 'plano',
'description' => '<string>',
'groupName' => 'Comercial',
'isPublic' => true,
'alwaysVisible' => false,
'options' => [
[
'name' => 'Plano',
'color' => '#6941C6'
]
]
]),
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://api.connectadesk.com/api/v1/custom-fields/{id}"
payload := strings.NewReader("{\n \"name\": \"Plano\",\n \"key\": \"plano\",\n \"description\": \"<string>\",\n \"groupName\": \"Comercial\",\n \"isPublic\": true,\n \"alwaysVisible\": false,\n \"options\": [\n {\n \"name\": \"Plano\",\n \"color\": \"#6941C6\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.connectadesk.com/api/v1/custom-fields/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Plano\",\n \"key\": \"plano\",\n \"description\": \"<string>\",\n \"groupName\": \"Comercial\",\n \"isPublic\": true,\n \"alwaysVisible\": false,\n \"options\": [\n {\n \"name\": \"Plano\",\n \"color\": \"#6941C6\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectadesk.com/api/v1/custom-fields/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Plano\",\n \"key\": \"plano\",\n \"description\": \"<string>\",\n \"groupName\": \"Comercial\",\n \"isPublic\": true,\n \"alwaysVisible\": false,\n \"options\": [\n {\n \"name\": \"Plano\",\n \"color\": \"#6941C6\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 44,
"key": "tipo_de_cliente",
"name": "Tipo de cliente",
"description": "Classificação comercial usada na régua de atendimento.",
"application": "contact",
"type": "select",
"groupName": "Comercial",
"isPublic": true,
"alwaysVisible": true,
"isSystem": false,
"order": 2,
"options": [
{
"id": 91,
"name": "Varejo",
"color": "#0E7490",
"order": 0
},
{
"id": 92,
"name": "Atacado",
"color": "#6941C6",
"order": 1
}
],
"createdAt": "2026-06-09T09:30:00.000Z",
"updatedAt": "2026-08-14T16:05:00.000Z"
}
}{
"error": {
"code": "ERR_API_VALIDATION",
"message": "O campo `number` é obrigatório."
}
}{
"error": {
"code": "ERR_API_UNAUTHORIZED",
"message": "Token de API ausente ou inválido."
}
}{
"error": {
"code": "ERR_API_FORBIDDEN_SCOPE",
"message": "O token não tem permissão para este método neste módulo. A mensagem real nomeia os dois."
}
}{
"error": {
"code": "ERR_API_NOT_FOUND",
"message": "Registro não encontrado."
}
}{
"error": {
"code": "ERR_API_IDEMPOTENCY_KEY_REUSED",
"message": "Idempotency-Key já usada com um corpo diferente."
}
}{
"error": {
"code": "ERR_API_VALIDATION",
"message": "O parâmetro `application` é obrigatório e aceita \"contact\" ou \"card\"."
}
}
