Deactivate Schema
curl --request DELETE \
--url https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}import requests
url = "https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}"
response = requests.delete(url)
print(response.text)const options = {method: 'DELETE'};
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 => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}")
.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::Delete.new(url)
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>",
"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": [],
"description": "<string>"
}
],
"dataConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_query": "<string>",
"sourceQuery": "<string>",
"deactivated_at": "<string>",
"deactivatedAt": "<string>",
"exposeNameJsonPath": "<string>"
}
}{
"message": "<string>",
"success": false,
"errors": [
"<string>"
]
}{
"success": true,
"message": "<string>",
"data": null
}{
"success": true,
"message": "<string>",
"data": null
}Schema Definitions
Deactivate Schema
Deactivates a schema definition, hiding it from list endpoints and freeing its name for reuse. This action is irreversible. All resources using this schema must be deleted first, and the schema must not be used in schema mappings or referenced by other schemas.
DELETE
/
partner
/
schema-definitions
/
{schemaIdOrName}
Deactivate Schema
curl --request DELETE \
--url https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}import requests
url = "https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}"
response = requests.delete(url)
print(response.text)const options = {method: 'DELETE'};
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 => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.embedreach.com/partner/schema-definitions/{schemaIdOrName}")
.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::Delete.new(url)
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>",
"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": [],
"description": "<string>"
}
],
"dataConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_query": "<string>",
"sourceQuery": "<string>",
"deactivated_at": "<string>",
"deactivatedAt": "<string>",
"exposeNameJsonPath": "<string>"
}
}{
"message": "<string>",
"success": false,
"errors": [
"<string>"
]
}{
"success": true,
"message": "<string>",
"data": null
}{
"success": true,
"message": "<string>",
"data": null
}⌘I