Relationships
Link relationship
Link a person to a custom object, or one custom object to another. Idempotent.
POST
/
api
/
v1
/
cdp
/
relationships
Link relationship
curl --request POST \
--url https://www.useboom.ai/api/v1/cdp/relationships \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"relationshipTypeId": "<string>",
"personExternalId": "<string>",
"customObjectExternalId": "<string>",
"parentExternalId": "<string>",
"childExternalId": "<string>"
}
'import requests
url = "https://www.useboom.ai/api/v1/cdp/relationships"
payload = {
"relationshipTypeId": "<string>",
"personExternalId": "<string>",
"customObjectExternalId": "<string>",
"parentExternalId": "<string>",
"childExternalId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
relationshipTypeId: '<string>',
personExternalId: '<string>',
customObjectExternalId: '<string>',
parentExternalId: '<string>',
childExternalId: '<string>'
})
};
fetch('https://www.useboom.ai/api/v1/cdp/relationships', 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://www.useboom.ai/api/v1/cdp/relationships",
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([
'relationshipTypeId' => '<string>',
'personExternalId' => '<string>',
'customObjectExternalId' => '<string>',
'parentExternalId' => '<string>',
'childExternalId' => '<string>'
]),
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://www.useboom.ai/api/v1/cdp/relationships"
payload := strings.NewReader("{\n \"relationshipTypeId\": \"<string>\",\n \"personExternalId\": \"<string>\",\n \"customObjectExternalId\": \"<string>\",\n \"parentExternalId\": \"<string>\",\n \"childExternalId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://www.useboom.ai/api/v1/cdp/relationships")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"relationshipTypeId\": \"<string>\",\n \"personExternalId\": \"<string>\",\n \"customObjectExternalId\": \"<string>\",\n \"parentExternalId\": \"<string>\",\n \"childExternalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/cdp/relationships")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"relationshipTypeId\": \"<string>\",\n \"personExternalId\": \"<string>\",\n \"customObjectExternalId\": \"<string>\",\n \"parentExternalId\": \"<string>\",\n \"childExternalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created": true,
"relationshipTypeId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Organization API key, sent as Authorization: Bearer boom_org_....
Body
application/json
Id of the relationship type (from the relationship-types list). Fixes the role and the custom object type(s) the edge targets.
Required string length:
1 - 255Edge kind. 'person_to_co' (default) links a person to a custom object; 'co_to_co' links a parent custom object to a child custom object.
Available options:
person_to_co, co_to_co Person externalId. Required when kind is 'person_to_co'.
Required string length:
1 - 255Custom object externalId. Required when kind is 'person_to_co'.
Required string length:
1 - 255Parent custom object externalId. Required when kind is 'co_to_co'.
Required string length:
1 - 255Child custom object externalId. Required when kind is 'co_to_co'.
Required string length:
1 - 255Was this page helpful?
⌘I
Link relationship
curl --request POST \
--url https://www.useboom.ai/api/v1/cdp/relationships \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"relationshipTypeId": "<string>",
"personExternalId": "<string>",
"customObjectExternalId": "<string>",
"parentExternalId": "<string>",
"childExternalId": "<string>"
}
'import requests
url = "https://www.useboom.ai/api/v1/cdp/relationships"
payload = {
"relationshipTypeId": "<string>",
"personExternalId": "<string>",
"customObjectExternalId": "<string>",
"parentExternalId": "<string>",
"childExternalId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
relationshipTypeId: '<string>',
personExternalId: '<string>',
customObjectExternalId: '<string>',
parentExternalId: '<string>',
childExternalId: '<string>'
})
};
fetch('https://www.useboom.ai/api/v1/cdp/relationships', 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://www.useboom.ai/api/v1/cdp/relationships",
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([
'relationshipTypeId' => '<string>',
'personExternalId' => '<string>',
'customObjectExternalId' => '<string>',
'parentExternalId' => '<string>',
'childExternalId' => '<string>'
]),
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://www.useboom.ai/api/v1/cdp/relationships"
payload := strings.NewReader("{\n \"relationshipTypeId\": \"<string>\",\n \"personExternalId\": \"<string>\",\n \"customObjectExternalId\": \"<string>\",\n \"parentExternalId\": \"<string>\",\n \"childExternalId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://www.useboom.ai/api/v1/cdp/relationships")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"relationshipTypeId\": \"<string>\",\n \"personExternalId\": \"<string>\",\n \"customObjectExternalId\": \"<string>\",\n \"parentExternalId\": \"<string>\",\n \"childExternalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.useboom.ai/api/v1/cdp/relationships")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"relationshipTypeId\": \"<string>\",\n \"personExternalId\": \"<string>\",\n \"customObjectExternalId\": \"<string>\",\n \"parentExternalId\": \"<string>\",\n \"childExternalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"created": true,
"relationshipTypeId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}