Update Schema
curl --request POST \
--url https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName} \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"schema": {},
"fieldsToExpose": [
{
"name": "<string>",
"jsonPath": "<string>",
"exposure": [],
"description": "<string>"
}
],
"exposeNameJsonPath": "<string>",
"external_id_field": "<string>",
"externalIdField": "<string>",
"displayMetadata": {
"label": "<string>",
"icon": {
"type": "lucide"
},
"color": "<string>",
"reporting": {
"status": {
"path": "<string>"
},
"effectiveDate": {
"path": "<string>"
},
"resourceLink": {
"source": "field",
"path": "<string>"
}
}
}
}
'import requests
url = "https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}"
payload = {
"description": "<string>",
"schema": {},
"fieldsToExpose": [
{
"name": "<string>",
"jsonPath": "<string>",
"exposure": [],
"description": "<string>"
}
],
"exposeNameJsonPath": "<string>",
"external_id_field": "<string>",
"externalIdField": "<string>",
"displayMetadata": {
"label": "<string>",
"icon": { "type": "lucide" },
"color": "<string>",
"reporting": {
"status": { "path": "<string>" },
"effectiveDate": { "path": "<string>" },
"resourceLink": {
"source": "field",
"path": "<string>"
}
}
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
schema: {},
fieldsToExpose: [
{name: '<string>', jsonPath: '<string>', exposure: [], description: '<string>'}
],
exposeNameJsonPath: '<string>',
external_id_field: '<string>',
externalIdField: '<string>',
displayMetadata: {
label: '<string>',
icon: {type: 'lucide'},
color: '<string>',
reporting: {
status: {path: '<string>'},
effectiveDate: {path: '<string>'},
resourceLink: {source: 'field', path: '<string>'}
}
}
})
};
fetch('https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}', 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.embedreach.com/partner/schema-definitions/{schemaIdOrName}",
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([
'description' => '<string>',
'schema' => [
],
'fieldsToExpose' => [
[
'name' => '<string>',
'jsonPath' => '<string>',
'exposure' => [
],
'description' => '<string>'
]
],
'exposeNameJsonPath' => '<string>',
'external_id_field' => '<string>',
'externalIdField' => '<string>',
'displayMetadata' => [
'label' => '<string>',
'icon' => [
'type' => 'lucide'
],
'color' => '<string>',
'reporting' => [
'status' => [
'path' => '<string>'
],
'effectiveDate' => [
'path' => '<string>'
],
'resourceLink' => [
'source' => 'field',
'path' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"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://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"schema\": {},\n \"fieldsToExpose\": [\n {\n \"name\": \"<string>\",\n \"jsonPath\": \"<string>\",\n \"exposure\": [],\n \"description\": \"<string>\"\n }\n ],\n \"exposeNameJsonPath\": \"<string>\",\n \"external_id_field\": \"<string>\",\n \"externalIdField\": \"<string>\",\n \"displayMetadata\": {\n \"label\": \"<string>\",\n \"icon\": {\n \"type\": \"lucide\"\n },\n \"color\": \"<string>\",\n \"reporting\": {\n \"status\": {\n \"path\": \"<string>\"\n },\n \"effectiveDate\": {\n \"path\": \"<string>\"\n },\n \"resourceLink\": {\n \"source\": \"field\",\n \"path\": \"<string>\"\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"schema\": {},\n \"fieldsToExpose\": [\n {\n \"name\": \"<string>\",\n \"jsonPath\": \"<string>\",\n \"exposure\": [],\n \"description\": \"<string>\"\n }\n ],\n \"exposeNameJsonPath\": \"<string>\",\n \"external_id_field\": \"<string>\",\n \"externalIdField\": \"<string>\",\n \"displayMetadata\": {\n \"label\": \"<string>\",\n \"icon\": {\n \"type\": \"lucide\"\n },\n \"color\": \"<string>\",\n \"reporting\": {\n \"status\": {\n \"path\": \"<string>\"\n },\n \"effectiveDate\": {\n \"path\": \"<string>\"\n },\n \"resourceLink\": {\n \"source\": \"field\",\n \"path\": \"<string>\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"schema\": {},\n \"fieldsToExpose\": [\n {\n \"name\": \"<string>\",\n \"jsonPath\": \"<string>\",\n \"exposure\": [],\n \"description\": \"<string>\"\n }\n ],\n \"exposeNameJsonPath\": \"<string>\",\n \"external_id_field\": \"<string>\",\n \"externalIdField\": \"<string>\",\n \"displayMetadata\": {\n \"label\": \"<string>\",\n \"icon\": {\n \"type\": \"lucide\"\n },\n \"color\": \"<string>\",\n \"reporting\": {\n \"status\": {\n \"path\": \"<string>\"\n },\n \"effectiveDate\": {\n \"path\": \"<string>\"\n },\n \"resourceLink\": {\n \"source\": \"field\",\n \"path\": \"<string>\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"plural_name": "<string>",
"pluralName": "<string>",
"description": "<string>",
"category": "contacts_schema",
"version_number": 123,
"versionNumber": 123,
"reference_schemas": [
"<string>"
],
"referenceSchemas": [
"<string>"
],
"schema": {},
"external_id_field": "<string>",
"externalIdField": "<string>",
"created_at": "<string>",
"createdAt": "<string>",
"updated_at": "<string>",
"updatedAt": "<string>",
"fieldsToExpose": [
{
"name": "<string>",
"jsonPath": "<string>",
"exposure": [
"segments"
],
"description": "<string>"
}
],
"dataConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_query": "<string>",
"sourceQuery": "<string>",
"deactivated_at": "<string>",
"deactivatedAt": "<string>",
"exposeNameJsonPath": "<string>",
"displayMetadata": {
"label": "<string>",
"icon": {
"type": "lucide",
"value": "User"
},
"color": "<string>",
"reporting": {
"status": {
"path": "<string>"
},
"effectiveDate": {
"path": "<string>"
},
"resourceLink": {
"source": "field",
"path": "<string>"
}
}
}
}
}{
"success": true,
"message": "<string>",
"data": {
"updateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"baseVersionNumber": 123,
"status": "pending",
"statusPath": "<string>"
}
}{
"message": "<string>",
"success": false,
"errors": [
"<string>"
]
}{
"success": true,
"message": "<string>",
"data": {
"error": "Cannot remove fields that are in use by existing resources",
"message": "<string>",
"conflicts": [
{
"field": "<string>",
"resourceExternalIds": [
"<string>"
]
}
]
}
}Schema Definitions
Update Schema
Updates an existing schema definition. The update can take up to 3 mins to take effect. Updates that change field rules are checked against the data already stored for every tenant, which can take longer than a client timeout on large schemas. A synchronous update still running after 60 seconds times out with a 504 and the change is not applied; read the versionNumber of the schema before retrying. While a background update to the schema is pending or running, every other update to it, synchronous or async, is refused with a 409 that names the running update and its statusPath. Pass async=true to run the update in the background: the response is a 202 with an update ID, and the result (the saved schema, or the same 409 conflict payload the synchronous update returns) is read from statusPath.
POST
/
partner
/
schema-definitions
/
{schemaIdOrName}
Update Schema
curl --request POST \
--url https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName} \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"schema": {},
"fieldsToExpose": [
{
"name": "<string>",
"jsonPath": "<string>",
"exposure": [],
"description": "<string>"
}
],
"exposeNameJsonPath": "<string>",
"external_id_field": "<string>",
"externalIdField": "<string>",
"displayMetadata": {
"label": "<string>",
"icon": {
"type": "lucide"
},
"color": "<string>",
"reporting": {
"status": {
"path": "<string>"
},
"effectiveDate": {
"path": "<string>"
},
"resourceLink": {
"source": "field",
"path": "<string>"
}
}
}
}
'import requests
url = "https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}"
payload = {
"description": "<string>",
"schema": {},
"fieldsToExpose": [
{
"name": "<string>",
"jsonPath": "<string>",
"exposure": [],
"description": "<string>"
}
],
"exposeNameJsonPath": "<string>",
"external_id_field": "<string>",
"externalIdField": "<string>",
"displayMetadata": {
"label": "<string>",
"icon": { "type": "lucide" },
"color": "<string>",
"reporting": {
"status": { "path": "<string>" },
"effectiveDate": { "path": "<string>" },
"resourceLink": {
"source": "field",
"path": "<string>"
}
}
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
schema: {},
fieldsToExpose: [
{name: '<string>', jsonPath: '<string>', exposure: [], description: '<string>'}
],
exposeNameJsonPath: '<string>',
external_id_field: '<string>',
externalIdField: '<string>',
displayMetadata: {
label: '<string>',
icon: {type: 'lucide'},
color: '<string>',
reporting: {
status: {path: '<string>'},
effectiveDate: {path: '<string>'},
resourceLink: {source: 'field', path: '<string>'}
}
}
})
};
fetch('https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}', 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.embedreach.com/partner/schema-definitions/{schemaIdOrName}",
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([
'description' => '<string>',
'schema' => [
],
'fieldsToExpose' => [
[
'name' => '<string>',
'jsonPath' => '<string>',
'exposure' => [
],
'description' => '<string>'
]
],
'exposeNameJsonPath' => '<string>',
'external_id_field' => '<string>',
'externalIdField' => '<string>',
'displayMetadata' => [
'label' => '<string>',
'icon' => [
'type' => 'lucide'
],
'color' => '<string>',
'reporting' => [
'status' => [
'path' => '<string>'
],
'effectiveDate' => [
'path' => '<string>'
],
'resourceLink' => [
'source' => 'field',
'path' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"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://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"schema\": {},\n \"fieldsToExpose\": [\n {\n \"name\": \"<string>\",\n \"jsonPath\": \"<string>\",\n \"exposure\": [],\n \"description\": \"<string>\"\n }\n ],\n \"exposeNameJsonPath\": \"<string>\",\n \"external_id_field\": \"<string>\",\n \"externalIdField\": \"<string>\",\n \"displayMetadata\": {\n \"label\": \"<string>\",\n \"icon\": {\n \"type\": \"lucide\"\n },\n \"color\": \"<string>\",\n \"reporting\": {\n \"status\": {\n \"path\": \"<string>\"\n },\n \"effectiveDate\": {\n \"path\": \"<string>\"\n },\n \"resourceLink\": {\n \"source\": \"field\",\n \"path\": \"<string>\"\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"schema\": {},\n \"fieldsToExpose\": [\n {\n \"name\": \"<string>\",\n \"jsonPath\": \"<string>\",\n \"exposure\": [],\n \"description\": \"<string>\"\n }\n ],\n \"exposeNameJsonPath\": \"<string>\",\n \"external_id_field\": \"<string>\",\n \"externalIdField\": \"<string>\",\n \"displayMetadata\": {\n \"label\": \"<string>\",\n \"icon\": {\n \"type\": \"lucide\"\n },\n \"color\": \"<string>\",\n \"reporting\": {\n \"status\": {\n \"path\": \"<string>\"\n },\n \"effectiveDate\": {\n \"path\": \"<string>\"\n },\n \"resourceLink\": {\n \"source\": \"field\",\n \"path\": \"<string>\"\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"schema\": {},\n \"fieldsToExpose\": [\n {\n \"name\": \"<string>\",\n \"jsonPath\": \"<string>\",\n \"exposure\": [],\n \"description\": \"<string>\"\n }\n ],\n \"exposeNameJsonPath\": \"<string>\",\n \"external_id_field\": \"<string>\",\n \"externalIdField\": \"<string>\",\n \"displayMetadata\": {\n \"label\": \"<string>\",\n \"icon\": {\n \"type\": \"lucide\"\n },\n \"color\": \"<string>\",\n \"reporting\": {\n \"status\": {\n \"path\": \"<string>\"\n },\n \"effectiveDate\": {\n \"path\": \"<string>\"\n },\n \"resourceLink\": {\n \"source\": \"field\",\n \"path\": \"<string>\"\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"plural_name": "<string>",
"pluralName": "<string>",
"description": "<string>",
"category": "contacts_schema",
"version_number": 123,
"versionNumber": 123,
"reference_schemas": [
"<string>"
],
"referenceSchemas": [
"<string>"
],
"schema": {},
"external_id_field": "<string>",
"externalIdField": "<string>",
"created_at": "<string>",
"createdAt": "<string>",
"updated_at": "<string>",
"updatedAt": "<string>",
"fieldsToExpose": [
{
"name": "<string>",
"jsonPath": "<string>",
"exposure": [
"segments"
],
"description": "<string>"
}
],
"dataConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_query": "<string>",
"sourceQuery": "<string>",
"deactivated_at": "<string>",
"deactivatedAt": "<string>",
"exposeNameJsonPath": "<string>",
"displayMetadata": {
"label": "<string>",
"icon": {
"type": "lucide",
"value": "User"
},
"color": "<string>",
"reporting": {
"status": {
"path": "<string>"
},
"effectiveDate": {
"path": "<string>"
},
"resourceLink": {
"source": "field",
"path": "<string>"
}
}
}
}
}{
"success": true,
"message": "<string>",
"data": {
"updateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"schemaDefinitionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"baseVersionNumber": 123,
"status": "pending",
"statusPath": "<string>"
}
}{
"message": "<string>",
"success": false,
"errors": [
"<string>"
]
}{
"success": true,
"message": "<string>",
"data": {
"error": "Cannot remove fields that are in use by existing resources",
"message": "<string>",
"conflicts": [
{
"field": "<string>",
"resourceExternalIds": [
"<string>"
]
}
]
}
}Path Parameters
The ID or name of the schema definition to update
Query Parameters
Set to true to run the update in the background. The response is 202 with an update ID; poll statusPath for the result. Use it for schemas with a lot of stored data, where the synchronous update can outlast client timeouts.
Available options:
true, false Body
application/json
The description of the schema
The JSONSchema schema definition for the resource
Show child attributes
Show child attributes
The fields to expose on the segment builder or merge fields.
Show child attributes
Show child attributes
The JSON path to the resource display name. Null clears the mapping; omit it to keep the existing mapping.
[Deprecated] Please use externalIdField instead. The field in the schema that is used as the unique ID in the partner system.
The field in the schema that is used as the unique ID in the partner system.
The category of the schema. Cannot be changed if it is used in active schema mappings.
Available options:
contacts_schema, transactions_schema, custom_schema, combined_schema, locations_schema, customer_fields Partial presentation and reporting metadata update. Null clears all metadata; nested nulls clear individual settings.
Show child attributes
Show child attributes