Actualizar un tipo de ítem personalizado
curl --request PATCH \
--url https://api.gotrebol.com/v2/custom-item-types/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"friendly_name": "<string>"
}
'import requests
url = "https://api.gotrebol.com/v2/custom-item-types/{id}"
payload = {
"name": "<string>",
"friendly_name": "<string>"
}
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>', friendly_name: '<string>'})
};
fetch('https://api.gotrebol.com/v2/custom-item-types/{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.gotrebol.com/v2/custom-item-types/{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>',
'friendly_name' => '<string>'
]),
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.gotrebol.com/v2/custom-item-types/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"friendly_name\": \"<string>\"\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.gotrebol.com/v2/custom-item-types/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"friendly_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gotrebol.com/v2/custom-item-types/{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 \"friendly_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "cit_abc123",
"name": "cit_contrato_arrendamiento_v2",
"friendly_name": "<string>",
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Tipos de Ítem Personalizados
Actualizar un tipo de ítem personalizado
Actualiza campos del tipo. Debes enviar al menos un campo.
Si todos los campos ya coinciden con los valores actuales, no se ejecuta ningún UPDATE y updated_at no cambia (idempotencia).
PATCH
/
v2
/
custom-item-types
/
{id}
Actualizar un tipo de ítem personalizado
curl --request PATCH \
--url https://api.gotrebol.com/v2/custom-item-types/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"friendly_name": "<string>"
}
'import requests
url = "https://api.gotrebol.com/v2/custom-item-types/{id}"
payload = {
"name": "<string>",
"friendly_name": "<string>"
}
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>', friendly_name: '<string>'})
};
fetch('https://api.gotrebol.com/v2/custom-item-types/{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.gotrebol.com/v2/custom-item-types/{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>',
'friendly_name' => '<string>'
]),
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.gotrebol.com/v2/custom-item-types/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"friendly_name\": \"<string>\"\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.gotrebol.com/v2/custom-item-types/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"friendly_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gotrebol.com/v2/custom-item-types/{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 \"friendly_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "cit_abc123",
"name": "cit_contrato_arrendamiento_v2",
"friendly_name": "<string>",
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Path Parameters
Identificador único del tipo de ítem personalizado (ej. cit_abc123).
Body
application/json
Debes enviar al menos un campo (name, friendly_name o status).
Renombra el tipo. No puede contener espacios. Única por cuenta.
Actualiza el nombre legible. Entre 2 y 255 caracteres.
archived: pausa el tipo, sigue en el listado y puede reactivarse. active: reactiva un tipo archivado.
Available options:
active, archived Was this page helpful?