Crear campo - Insurance Boosters API

POST

databases

{databaseId}

fields

Crear campo

curl --request POST \
  --url https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields \
  --header 'Content-Type: application/json' \
  --header 'x-ib-api-key: <api-key>' \
  --data '
{
  "name": "Estado",
  "type": "enum"
}
'

import requests

url = "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields"

payload = {
    "name": "Estado",
    "type": "enum"
}
headers = {
    "x-ib-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-ib-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Estado', type: 'enum'})
};

fetch('https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {'x-ib-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Estado', type: 'enum'})
};

fetch('https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields';
const options = {
  method: 'POST',
  headers: {'x-ib-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Estado', type: 'enum'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields")
  .header("x-ib-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Estado\",\n  \"type\": \"enum\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
request.AddJsonBody("{\n  \"name\": \"Estado\",\n  \"type\": \"enum\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
request.AddJsonBody("{\n  \"name\": \"Estado\",\n  \"type\": \"enum\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields"

	payload := strings.NewReader("{\n  \"name\": \"Estado\",\n  \"type\": \"enum\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-ib-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))

}

require 'uri'
require 'net/http'

url = URI("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-ib-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Estado\",\n  \"type\": \"enum\"\n}"

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields",
  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([
    'name' => 'Estado',
    'type' => 'enum'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-ib-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"name\": \"Estado\",\n  \"type\": \"enum\"\n}")
val request = Request.Builder()
  .url("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields")
  .post(body)
  .addHeader("x-ib-api-key", "<api-key>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

import Foundation

let parameters = [
  "name": "Estado",
  "type": "enum"
] as [String : Any?]

let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])

let url = URL(string: "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
  "x-ib-api-key": "<api-key>",
  "Content-Type": "application/json"
]
request.httpBody = postData

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

$headers=@{}
$headers.Add("x-ib-api-key", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "name": "Estado",
  "type": "enum"
}'

{
  "name": "<string>",
  "key": "<string>",
  "type": "string",
  "id": "<string>",
  "required": false,
  "description": "<string>",
  "defaultValue": "<unknown>",
  "dateConfig": {
    "includeTime": false
  },
  "options": [
    {
      "label": "<string>",
      "id": "<string>",
      "color": "<string>",
      "order": 1
    }
  ],
  "toDatabaseId": "<string>",
  "displayFieldId": "<string>",
  "bidirectional": false,
  "inverseField": {
    "id": "<string>",
    "name": "<string>",
    "key": "<string>",
    "type": "relation_single",
    "displayFieldId": "<string>"
  },
  "relationFieldId": "<string>",
  "targetFieldId": "<string>",
  "multipleValuesBehavior": "allValues",
  "maxFiles": 2,
  "accept": [
    "<string>"
  ],
  "numberFormat": {
    "type": "none",
    "currencyCode": "USD",
    "decimalPlaces": 2,
    "thousandsSeparator": true
  },
  "pdfTemplateConfig": {
    "buttonLabel": "<string>",
    "templates": [
      {
        "id": "<string>",
        "name": "<string>",
        "orientation": "portrait",
        "fileNameTemplate": "<string>"
      }
    ]
  },
  "inverseFieldId": "<string>",
  "relationPairId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

Agrega un campo al esquema del tablero.

Endpoint

POST /databases/{databaseId}/fields

Body común

Campo	Tipo	Requerido	Descripción
`name`	`string`	Sí	Nombre visible del campo.
`type`	`string`	Sí	Tipo de dato.
`key`	`string`	No	Clave estable para `values`; si la omites, se genera desde `name`.
`required`	`boolean`	No	Marca el campo como obligatorio en el esquema y en la captura del tablero.
`description`	`string`	No	Ayuda para quien captura datos.
`defaultValue`	Cualquiera	No	Valor predeterminado para tipos compatibles.

La key debe iniciar con una letra minúscula y usar camelCase o snake_case. Después de crear el campo, key y type son inmutables. Cada type admite propiedades diferentes. Consulta Tipos y configuración de campos antes de construir el body.

Ejemplo: campo de selección

curl -X POST "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields" \
  -H "Content-Type: application/json" \
  -H "x-ib-api-key: TU_API_KEY" \
  -d '{
    "name": "Estado",
    "key": "estado",
    "type": "enum",
    "required": true,
    "options": [
      { "label": "Vigente", "color": "green" },
      { "label": "Cancelada", "color": "red" }
    ]
  }'

Respuesta exitosa (`201`)

Devuelve el campo creado con id, key y la configuración normalizada.

{
  "id": "<field-id>",
  "key": "estado",
  "name": "Estado",
  "type": "enum",
  "required": true,
  "options": [
    { "id": "vigente", "label": "Vigente", "color": "green", "order": 0 },
    { "id": "cancelada", "label": "Cancelada", "color": "red", "order": 1 }
  ]
}

Errores frecuentes

HTTP	Qué significa	Qué hacer
`400`	Configuración inválida o incompleta.	Revisa los campos requeridos para el `type`.
`403`	Tu integración no puede modificar el tablero.	Confirma el acceso al tablero.
`404`	El tablero no existe.	Confirma `databaseId`.

Authorizations

x-ib-api-key

string

header

required

API key de Insurance Boosters.

Path Parameters

databaseId

string

required

ID del tablero.

Body

application/json

name

string

required

Nombre visible del campo.

Minimum string length: 1

type

enum<string>

required

Tipo inmutable después de crear el campo.

Available options:

string,

number,

boolean,

date,

enum,

enum_multi,

relation_single,

relation_multi,

contact_single,

contact_multi,

lookup,

files,

pdf_template

key

string

Clave estable; se genera desde name si la omites.

Pattern: ^[a-z][a-zA-Z0-9]*(?:_[a-z0-9]+)*$

required

boolean

default:false

Marca el campo como obligatorio en el esquema y en la captura del tablero.

description

string

defaultValue

any

Valor predeterminado para tipos compatibles.

dateConfig

object

Configuración de presentación cuando type es date.

Show child attributes

options

object[]

Requerido para enum y enum_multi.

Minimum array length: 1

Show child attributes

toDatabaseId

string

Requerido para campos de relación.

displayFieldId

string

Campo mostrado en relaciones o contactos.

bidirectional

boolean

default:false

inverseField

object

Vincula un campo existente con id o crea uno nuevo con name y type.

Show child attributes

relationFieldId

string

Requerido para lookup.

targetFieldId

string

Requerido para lookup.

multipleValuesBehavior

enum<string>

Requerido para lookup.

Available options:

allValues,

uniqueValues,

firstValue,

lastValue

maxFiles

integer

Máximo de archivos cuando type es files.

Required range: x >= 1

string[]

Tipos MIME aceptados cuando type es files.

numberFormat

object

Show child attributes

pdfTemplateConfig

object

Requerido cuando type es pdf_template.

Show child attributes

Response

Campo creado.

name

string

required

Nombre visible del campo.

Minimum string length: 1

key

string

required

Clave estable; se genera desde name si la omites.

Pattern: ^[a-z][a-zA-Z0-9]*(?:_[a-z0-9]+)*$

type

enum<string>

required

Tipo inmutable después de crear el campo.

Available options:

string,

number,

boolean,

date,

enum,

enum_multi,

relation_single,

relation_multi,

contact_single,

contact_multi,

lookup,

files,

pdf_template

string

required

boolean

default:false

Marca el campo como obligatorio en el esquema y en la captura del tablero.

description

string

defaultValue

any

Valor predeterminado para tipos compatibles.

dateConfig

object

Configuración de presentación cuando type es date.

Show child attributes

options

object[]

Requerido para enum y enum_multi.

Minimum array length: 1

Show child attributes

toDatabaseId

string

Requerido para campos de relación.

displayFieldId

string

Campo mostrado en relaciones o contactos.

bidirectional

boolean

default:false

inverseField

object

Vincula un campo existente con id o crea uno nuevo con name y type.

Show child attributes

relationFieldId

string

Requerido para lookup.

targetFieldId

string

Requerido para lookup.

multipleValuesBehavior

enum<string>

Requerido para lookup.

Available options:

allValues,

uniqueValues,

firstValue,

lastValue

maxFiles

integer

Máximo de archivos cuando type es files.

Required range: x >= 1

string[]

Tipos MIME aceptados cuando type es files.

numberFormat

object

Show child attributes

pdfTemplateConfig

object

Requerido cuando type es pdf_template.

Show child attributes

inverseFieldId

string

relationPairId

string

Crear campo

curl --request POST \
  --url https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields \
  --header 'Content-Type: application/json' \
  --header 'x-ib-api-key: <api-key>' \
  --data '
{
  "name": "Estado",
  "type": "enum"
}
'

import requests

url = "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields"

payload = {
    "name": "Estado",
    "type": "enum"
}
headers = {
    "x-ib-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-ib-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Estado', type: 'enum'})
};

fetch('https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {'x-ib-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Estado', type: 'enum'})
};

fetch('https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields';
const options = {
  method: 'POST',
  headers: {'x-ib-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Estado', type: 'enum'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields")
  .header("x-ib-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Estado\",\n  \"type\": \"enum\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
request.AddJsonBody("{\n  \"name\": \"Estado\",\n  \"type\": \"enum\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
request.AddJsonBody("{\n  \"name\": \"Estado\",\n  \"type\": \"enum\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields"

	payload := strings.NewReader("{\n  \"name\": \"Estado\",\n  \"type\": \"enum\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-ib-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))

}

require 'uri'
require 'net/http'

url = URI("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-ib-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Estado\",\n  \"type\": \"enum\"\n}"

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields",
  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([
    'name' => 'Estado',
    'type' => 'enum'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-ib-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"name\": \"Estado\",\n  \"type\": \"enum\"\n}")
val request = Request.Builder()
  .url("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields")
  .post(body)
  .addHeader("x-ib-api-key", "<api-key>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

import Foundation

let parameters = [
  "name": "Estado",
  "type": "enum"
] as [String : Any?]

let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])

let url = URL(string: "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
  "x-ib-api-key": "<api-key>",
  "Content-Type": "application/json"
]
request.httpBody = postData

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

$headers=@{}
$headers.Add("x-ib-api-key", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "name": "Estado",
  "type": "enum"
}'

{
  "name": "<string>",
  "key": "<string>",
  "type": "string",
  "id": "<string>",
  "required": false,
  "description": "<string>",
  "defaultValue": "<unknown>",
  "dateConfig": {
    "includeTime": false
  },
  "options": [
    {
      "label": "<string>",
      "id": "<string>",
      "color": "<string>",
      "order": 1
    }
  ],
  "toDatabaseId": "<string>",
  "displayFieldId": "<string>",
  "bidirectional": false,
  "inverseField": {
    "id": "<string>",
    "name": "<string>",
    "key": "<string>",
    "type": "relation_single",
    "displayFieldId": "<string>"
  },
  "relationFieldId": "<string>",
  "targetFieldId": "<string>",
  "multipleValuesBehavior": "allValues",
  "maxFiles": 2,
  "accept": [
    "<string>"
  ],
  "numberFormat": {
    "type": "none",
    "currencyCode": "USD",
    "decimalPlaces": 2,
    "thousandsSeparator": true
  },
  "pdfTemplateConfig": {
    "buttonLabel": "<string>",
    "templates": [
      {
        "id": "<string>",
        "name": "<string>",
        "orientation": "portrait",
        "fileNameTemplate": "<string>"
      }
    ]
  },
  "inverseFieldId": "<string>",
  "relationPairId": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "error": "<string>"
}

​Endpoint

​Body común

​Ejemplo: campo de selección

​Respuesta exitosa (201)

​Errores frecuentes

Authorizations

Path Parameters

Body

Response

Endpoint

Body común

Ejemplo: campo de selección

Respuesta exitosa (`201`)

Errores frecuentes