Desvincular relación bidireccional - Insurance Boosters API

POST

databases

{databaseId}

fields

{fieldId}

unlink

Desvincular relación

curl --request POST \
  --url https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink \
  --header 'x-ib-api-key: <api-key>'

import requests

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

headers = {"x-ib-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'POST', headers: {'x-ib-api-key': '<api-key>'}};

fetch('https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink', 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>'}};

fetch('https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink', 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/{fieldId}/unlink';
const options = {method: 'POST', headers: {'x-ib-api-key': '<api-key>'}};

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

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
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/{fieldId}/unlink");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.PostAsync(request);

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

package main

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

func main() {

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

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

	req.Header.Add("x-ib-api-key", "<api-key>")

	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/{fieldId}/unlink")

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>'

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/{fieldId}/unlink",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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 request = Request.Builder()
  .url("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink")
  .post(null)
  .addHeader("x-ib-api-key", "<api-key>")
  .build()

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

import Foundation

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

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>")
$response = Invoke-WebRequest -Uri 'https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink' -Method POST -Headers $headers

{
  "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>"
}

Separa un par bidireccional. Ambos campos permanecen como relaciones de un solo sentido y los valores existentes no cambian.

Endpoint

POST /databases/{databaseId}/fields/{fieldId}/unlink

Esta operación no requiere body.

Ejemplo de solicitud

curl -X POST "https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink" \
  -H "x-ib-api-key: TU_API_KEY"

Respuesta exitosa (`200`)

Devuelve el campo fuente sin la configuración del par bidireccional.

{
  "id": "<field-id>",
  "key": "cliente",
  "name": "Cliente",
  "type": "relation_single",
  "toDatabaseId": "<target-database-id>",
  "bidirectional": false
}

Errores frecuentes

HTTP	Qué significa	Qué hacer
`400`	El campo no pertenece a un par bidireccional válido.	Consulta el tablero y revisa la configuración del campo.
`403`	Tu integración no puede modificar uno de los tableros.	Confirma el acceso.
`404`	El tablero o el campo no existe.	Confirma los IDs.

Authorizations

x-ib-api-key

string

header

required

API key de Insurance Boosters.

Path Parameters

databaseId

string

required

ID del tablero.

fieldId

string

required

ID inmutable del campo.

Response

Relación desvinculada.

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

Desvincular relación

curl --request POST \
  --url https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink \
  --header 'x-ib-api-key: <api-key>'

import requests

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

headers = {"x-ib-api-key": "<api-key>"}

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

print(response.text)

const options = {method: 'POST', headers: {'x-ib-api-key': '<api-key>'}};

fetch('https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink', 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>'}};

fetch('https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink', 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/{fieldId}/unlink';
const options = {method: 'POST', headers: {'x-ib-api-key': '<api-key>'}};

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

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
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/{fieldId}/unlink");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.PostAsync(request);

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

package main

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

func main() {

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

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

	req.Header.Add("x-ib-api-key", "<api-key>")

	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/{fieldId}/unlink")

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>'

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/{fieldId}/unlink",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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 request = Request.Builder()
  .url("https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink")
  .post(null)
  .addHeader("x-ib-api-key", "<api-key>")
  .build()

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

import Foundation

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

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>")
$response = Invoke-WebRequest -Uri 'https://api.insuranceboosters.com/api/v1/databases/{databaseId}/fields/{fieldId}/unlink' -Method POST -Headers $headers

{
  "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

​Ejemplo de solicitud

​Respuesta exitosa (200)

​Errores frecuentes

Authorizations

Path Parameters

Response

Endpoint

Ejemplo de solicitud

Respuesta exitosa (`200`)

Errores frecuentes