Create Relationship Fields
curl --request POST \
--url https://pub-api.conversion.ai/api/v2/fields/relationships \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"source": {
"objectType": "CUSTOM_OBJECT",
"customObjectId": "528f0cc5-431c-4f3b-9d3c-7204740a3f76",
"key": "organization",
"label": "Organization"
},
"target": {
"objectType": "CUSTOM_OBJECT",
"customObjectId": "f4f9ae15-12e8-4b3f-9822-22166d455f40",
"key": "dashboard_users",
"label": "Dashboard Users"
}
}
'import requests
url = "https://pub-api.conversion.ai/api/v2/fields/relationships"
payload = {
"source": {
"objectType": "CUSTOM_OBJECT",
"customObjectId": "528f0cc5-431c-4f3b-9d3c-7204740a3f76",
"key": "organization",
"label": "Organization"
},
"target": {
"objectType": "CUSTOM_OBJECT",
"customObjectId": "f4f9ae15-12e8-4b3f-9822-22166d455f40",
"key": "dashboard_users",
"label": "Dashboard Users"
}
}
headers = {
"X-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-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source: {
objectType: 'CUSTOM_OBJECT',
customObjectId: '528f0cc5-431c-4f3b-9d3c-7204740a3f76',
key: 'organization',
label: 'Organization'
},
target: {
objectType: 'CUSTOM_OBJECT',
customObjectId: 'f4f9ae15-12e8-4b3f-9822-22166d455f40',
key: 'dashboard_users',
label: 'Dashboard Users'
}
})
};
fetch('https://pub-api.conversion.ai/api/v2/fields/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://pub-api.conversion.ai/api/v2/fields/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([
'source' => [
'objectType' => 'CUSTOM_OBJECT',
'customObjectId' => '528f0cc5-431c-4f3b-9d3c-7204740a3f76',
'key' => 'organization',
'label' => 'Organization'
],
'target' => [
'objectType' => 'CUSTOM_OBJECT',
'customObjectId' => 'f4f9ae15-12e8-4b3f-9822-22166d455f40',
'key' => 'dashboard_users',
'label' => 'Dashboard Users'
]
]),
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://pub-api.conversion.ai/api/v2/fields/relationships"
payload := strings.NewReader("{\n \"source\": {\n \"objectType\": \"CUSTOM_OBJECT\",\n \"customObjectId\": \"528f0cc5-431c-4f3b-9d3c-7204740a3f76\",\n \"key\": \"organization\",\n \"label\": \"Organization\"\n },\n \"target\": {\n \"objectType\": \"CUSTOM_OBJECT\",\n \"customObjectId\": \"f4f9ae15-12e8-4b3f-9822-22166d455f40\",\n \"key\": \"dashboard_users\",\n \"label\": \"Dashboard Users\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://pub-api.conversion.ai/api/v2/fields/relationships")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"source\": {\n \"objectType\": \"CUSTOM_OBJECT\",\n \"customObjectId\": \"528f0cc5-431c-4f3b-9d3c-7204740a3f76\",\n \"key\": \"organization\",\n \"label\": \"Organization\"\n },\n \"target\": {\n \"objectType\": \"CUSTOM_OBJECT\",\n \"customObjectId\": \"f4f9ae15-12e8-4b3f-9822-22166d455f40\",\n \"key\": \"dashboard_users\",\n \"label\": \"Dashboard Users\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pub-api.conversion.ai/api/v2/fields/relationships")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": {\n \"objectType\": \"CUSTOM_OBJECT\",\n \"customObjectId\": \"528f0cc5-431c-4f3b-9d3c-7204740a3f76\",\n \"key\": \"organization\",\n \"label\": \"Organization\"\n },\n \"target\": {\n \"objectType\": \"CUSTOM_OBJECT\",\n \"customObjectId\": \"f4f9ae15-12e8-4b3f-9822-22166d455f40\",\n \"key\": \"dashboard_users\",\n \"label\": \"Dashboard Users\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"sourceField": {
"key": "organization",
"objectType": "CUSTOM_OBJECT",
"customObjectId": "528f0cc5-431c-4f3b-9d3c-7204740a3f76"
},
"relatedFields": [
{
"key": "dashboard_users",
"objectType": "CUSTOM_OBJECT",
"customObjectId": "f4f9ae15-12e8-4b3f-9822-22166d455f40"
}
]
}
}{
"error": {
"code": "invalid_email",
"message": "invalid email format: not-an-email"
}
}{
"error": {
"code": "invalid_email",
"message": "invalid email format: not-an-email"
}
}{
"error": {
"code": "invalid_email",
"message": "invalid email format: not-an-email"
}
}{
"error": {
"code": "invalid_email",
"message": "invalid email format: not-an-email"
}
}{
"error": {
"code": "invalid_email",
"message": "invalid email format: not-an-email"
}
}Fields
Create Relationship Fields
Create a writable source field and its automatically maintained reverse field. For example, a dashboard user has one organization, and the organization lists its dashboard users. Updating the source field on a record maintains the reverse side. Requires field creation permission and edit access to each custom object. This creates the field definitions; it does not link any records.
POST
/
v2
/
fields
/
relationships
Create Relationship Fields
curl --request POST \
--url https://pub-api.conversion.ai/api/v2/fields/relationships \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"source": {
"objectType": "CUSTOM_OBJECT",
"customObjectId": "528f0cc5-431c-4f3b-9d3c-7204740a3f76",
"key": "organization",
"label": "Organization"
},
"target": {
"objectType": "CUSTOM_OBJECT",
"customObjectId": "f4f9ae15-12e8-4b3f-9822-22166d455f40",
"key": "dashboard_users",
"label": "Dashboard Users"
}
}
'import requests
url = "https://pub-api.conversion.ai/api/v2/fields/relationships"
payload = {
"source": {
"objectType": "CUSTOM_OBJECT",
"customObjectId": "528f0cc5-431c-4f3b-9d3c-7204740a3f76",
"key": "organization",
"label": "Organization"
},
"target": {
"objectType": "CUSTOM_OBJECT",
"customObjectId": "f4f9ae15-12e8-4b3f-9822-22166d455f40",
"key": "dashboard_users",
"label": "Dashboard Users"
}
}
headers = {
"X-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-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
source: {
objectType: 'CUSTOM_OBJECT',
customObjectId: '528f0cc5-431c-4f3b-9d3c-7204740a3f76',
key: 'organization',
label: 'Organization'
},
target: {
objectType: 'CUSTOM_OBJECT',
customObjectId: 'f4f9ae15-12e8-4b3f-9822-22166d455f40',
key: 'dashboard_users',
label: 'Dashboard Users'
}
})
};
fetch('https://pub-api.conversion.ai/api/v2/fields/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://pub-api.conversion.ai/api/v2/fields/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([
'source' => [
'objectType' => 'CUSTOM_OBJECT',
'customObjectId' => '528f0cc5-431c-4f3b-9d3c-7204740a3f76',
'key' => 'organization',
'label' => 'Organization'
],
'target' => [
'objectType' => 'CUSTOM_OBJECT',
'customObjectId' => 'f4f9ae15-12e8-4b3f-9822-22166d455f40',
'key' => 'dashboard_users',
'label' => 'Dashboard Users'
]
]),
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://pub-api.conversion.ai/api/v2/fields/relationships"
payload := strings.NewReader("{\n \"source\": {\n \"objectType\": \"CUSTOM_OBJECT\",\n \"customObjectId\": \"528f0cc5-431c-4f3b-9d3c-7204740a3f76\",\n \"key\": \"organization\",\n \"label\": \"Organization\"\n },\n \"target\": {\n \"objectType\": \"CUSTOM_OBJECT\",\n \"customObjectId\": \"f4f9ae15-12e8-4b3f-9822-22166d455f40\",\n \"key\": \"dashboard_users\",\n \"label\": \"Dashboard Users\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://pub-api.conversion.ai/api/v2/fields/relationships")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"source\": {\n \"objectType\": \"CUSTOM_OBJECT\",\n \"customObjectId\": \"528f0cc5-431c-4f3b-9d3c-7204740a3f76\",\n \"key\": \"organization\",\n \"label\": \"Organization\"\n },\n \"target\": {\n \"objectType\": \"CUSTOM_OBJECT\",\n \"customObjectId\": \"f4f9ae15-12e8-4b3f-9822-22166d455f40\",\n \"key\": \"dashboard_users\",\n \"label\": \"Dashboard Users\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pub-api.conversion.ai/api/v2/fields/relationships")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": {\n \"objectType\": \"CUSTOM_OBJECT\",\n \"customObjectId\": \"528f0cc5-431c-4f3b-9d3c-7204740a3f76\",\n \"key\": \"organization\",\n \"label\": \"Organization\"\n },\n \"target\": {\n \"objectType\": \"CUSTOM_OBJECT\",\n \"customObjectId\": \"f4f9ae15-12e8-4b3f-9822-22166d455f40\",\n \"key\": \"dashboard_users\",\n \"label\": \"Dashboard Users\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"sourceField": {
"key": "organization",
"objectType": "CUSTOM_OBJECT",
"customObjectId": "528f0cc5-431c-4f3b-9d3c-7204740a3f76"
},
"relatedFields": [
{
"key": "dashboard_users",
"objectType": "CUSTOM_OBJECT",
"customObjectId": "f4f9ae15-12e8-4b3f-9822-22166d455f40"
}
]
}
}{
"error": {
"code": "invalid_email",
"message": "invalid email format: not-an-email"
}
}{
"error": {
"code": "invalid_email",
"message": "invalid email format: not-an-email"
}
}{
"error": {
"code": "invalid_email",
"message": "invalid email format: not-an-email"
}
}{
"error": {
"code": "invalid_email",
"message": "invalid email format: not-an-email"
}
}{
"error": {
"code": "invalid_email",
"message": "invalid email format: not-an-email"
}
}Authorizations
Your Conversion API key. Found in Settings > Integrations in the dashboard. Format: sk_live_<key_id>_<secret>.
Body
application/json
Response
Relationship fields created.
Show child attributes
Show child attributes
Was this page helpful?