Dry-run an export against real rows
curl --request POST \
--url https://api.getoneprofile.ai/table-writeback/preview/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"fields": [
{
"destination_field": "<string>",
"source": {
"template": {
"format": "plain",
"segments": [
{
"text": "<string>",
"type": "text"
}
]
}
},
"skip_if_blank": true
}
],
"integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_type": "<string>",
"record_type": "<string>",
"action": "upsert",
"batched": false,
"identity": [
{
"destination_field": "<string>",
"source": {
"template": {
"format": "plain",
"segments": [
{
"text": "<string>",
"type": "text"
}
]
}
}
}
],
"kind": "export",
"only_on_change": true,
"remove_blanks": true,
"retry": {
"max_retries": 3,
"requests_per_minute": 3000,
"retry_on_failure": true,
"timeout_seconds": 300
},
"typecast": true,
"update_mode": "patch"
},
"record_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.getoneprofile.ai/table-writeback/preview/"
payload = {
"definition": {
"fields": [
{
"destination_field": "<string>",
"source": { "template": {
"format": "plain",
"segments": [
{
"text": "<string>",
"type": "text"
}
]
} },
"skip_if_blank": True
}
],
"integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_type": "<string>",
"record_type": "<string>",
"action": "upsert",
"batched": False,
"identity": [
{
"destination_field": "<string>",
"source": { "template": {
"format": "plain",
"segments": [
{
"text": "<string>",
"type": "text"
}
]
} }
}
],
"kind": "export",
"only_on_change": True,
"remove_blanks": True,
"retry": {
"max_retries": 3,
"requests_per_minute": 3000,
"retry_on_failure": True,
"timeout_seconds": 300
},
"typecast": True,
"update_mode": "patch"
},
"record_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
definition: {
fields: [
{
destination_field: '<string>',
source: {template: {format: 'plain', segments: [{text: '<string>', type: 'text'}]}},
skip_if_blank: true
}
],
integration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
integration_type: '<string>',
record_type: '<string>',
action: 'upsert',
batched: false,
identity: [
{
destination_field: '<string>',
source: {template: {format: 'plain', segments: [{text: '<string>', type: 'text'}]}}
}
],
kind: 'export',
only_on_change: true,
remove_blanks: true,
retry: {
max_retries: 3,
requests_per_minute: 3000,
retry_on_failure: true,
timeout_seconds: 300
},
typecast: true,
update_mode: 'patch'
},
record_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
table_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.getoneprofile.ai/table-writeback/preview/', 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.getoneprofile.ai/table-writeback/preview/",
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([
'definition' => [
'fields' => [
[
'destination_field' => '<string>',
'source' => [
'template' => [
'format' => 'plain',
'segments' => [
[
'text' => '<string>',
'type' => 'text'
]
]
]
],
'skip_if_blank' => true
]
],
'integration_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'integration_type' => '<string>',
'record_type' => '<string>',
'action' => 'upsert',
'batched' => false,
'identity' => [
[
'destination_field' => '<string>',
'source' => [
'template' => [
'format' => 'plain',
'segments' => [
[
'text' => '<string>',
'type' => 'text'
]
]
]
]
]
],
'kind' => 'export',
'only_on_change' => true,
'remove_blanks' => true,
'retry' => [
'max_retries' => 3,
'requests_per_minute' => 3000,
'retry_on_failure' => true,
'timeout_seconds' => 300
],
'typecast' => true,
'update_mode' => 'patch'
],
'record_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'table_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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://api.getoneprofile.ai/table-writeback/preview/"
payload := strings.NewReader("{\n \"definition\": {\n \"fields\": [\n {\n \"destination_field\": \"<string>\",\n \"source\": {\n \"template\": {\n \"format\": \"plain\",\n \"segments\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ]\n }\n },\n \"skip_if_blank\": true\n }\n ],\n \"integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"integration_type\": \"<string>\",\n \"record_type\": \"<string>\",\n \"action\": \"upsert\",\n \"batched\": false,\n \"identity\": [\n {\n \"destination_field\": \"<string>\",\n \"source\": {\n \"template\": {\n \"format\": \"plain\",\n \"segments\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ]\n }\n }\n }\n ],\n \"kind\": \"export\",\n \"only_on_change\": true,\n \"remove_blanks\": true,\n \"retry\": {\n \"max_retries\": 3,\n \"requests_per_minute\": 3000,\n \"retry_on_failure\": true,\n \"timeout_seconds\": 300\n },\n \"typecast\": true,\n \"update_mode\": \"patch\"\n },\n \"record_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://api.getoneprofile.ai/table-writeback/preview/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {\n \"fields\": [\n {\n \"destination_field\": \"<string>\",\n \"source\": {\n \"template\": {\n \"format\": \"plain\",\n \"segments\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ]\n }\n },\n \"skip_if_blank\": true\n }\n ],\n \"integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"integration_type\": \"<string>\",\n \"record_type\": \"<string>\",\n \"action\": \"upsert\",\n \"batched\": false,\n \"identity\": [\n {\n \"destination_field\": \"<string>\",\n \"source\": {\n \"template\": {\n \"format\": \"plain\",\n \"segments\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ]\n }\n }\n }\n ],\n \"kind\": \"export\",\n \"only_on_change\": true,\n \"remove_blanks\": true,\n \"retry\": {\n \"max_retries\": 3,\n \"requests_per_minute\": 3000,\n \"retry_on_failure\": true,\n \"timeout_seconds\": 300\n },\n \"typecast\": true,\n \"update_mode\": \"patch\"\n },\n \"record_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/table-writeback/preview/")
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 \"definition\": {\n \"fields\": [\n {\n \"destination_field\": \"<string>\",\n \"source\": {\n \"template\": {\n \"format\": \"plain\",\n \"segments\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ]\n }\n },\n \"skip_if_blank\": true\n }\n ],\n \"integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"integration_type\": \"<string>\",\n \"record_type\": \"<string>\",\n \"action\": \"upsert\",\n \"batched\": false,\n \"identity\": [\n {\n \"destination_field\": \"<string>\",\n \"source\": {\n \"template\": {\n \"format\": \"plain\",\n \"segments\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ]\n }\n }\n }\n ],\n \"kind\": \"export\",\n \"only_on_change\": true,\n \"remove_blanks\": true,\n \"retry\": {\n \"max_retries\": 3,\n \"requests_per_minute\": 3000,\n \"retry_on_failure\": true,\n \"timeout_seconds\": 300\n },\n \"typecast\": true,\n \"update_mode\": \"patch\"\n },\n \"record_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"rows": [
{
"error": "<string>",
"identity": {},
"matched_record_id": "<string>",
"properties": {},
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"skipped_reason": "<string>",
"would": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}table-writeback
Dry-run an export against real rows
Render each row’s outgoing payload exactly as a real run would, ask the destination (READ-ONLY) whether the row matches an existing record, and report what a real run would do — create, update or skip.
NOTHING is written. The write half of the executor is unreachable from this path.
POST
/
table-writeback
/
preview
/
Dry-run an export against real rows
curl --request POST \
--url https://api.getoneprofile.ai/table-writeback/preview/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"definition": {
"fields": [
{
"destination_field": "<string>",
"source": {
"template": {
"format": "plain",
"segments": [
{
"text": "<string>",
"type": "text"
}
]
}
},
"skip_if_blank": true
}
],
"integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_type": "<string>",
"record_type": "<string>",
"action": "upsert",
"batched": false,
"identity": [
{
"destination_field": "<string>",
"source": {
"template": {
"format": "plain",
"segments": [
{
"text": "<string>",
"type": "text"
}
]
}
}
}
],
"kind": "export",
"only_on_change": true,
"remove_blanks": true,
"retry": {
"max_retries": 3,
"requests_per_minute": 3000,
"retry_on_failure": true,
"timeout_seconds": 300
},
"typecast": true,
"update_mode": "patch"
},
"record_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.getoneprofile.ai/table-writeback/preview/"
payload = {
"definition": {
"fields": [
{
"destination_field": "<string>",
"source": { "template": {
"format": "plain",
"segments": [
{
"text": "<string>",
"type": "text"
}
]
} },
"skip_if_blank": True
}
],
"integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"integration_type": "<string>",
"record_type": "<string>",
"action": "upsert",
"batched": False,
"identity": [
{
"destination_field": "<string>",
"source": { "template": {
"format": "plain",
"segments": [
{
"text": "<string>",
"type": "text"
}
]
} }
}
],
"kind": "export",
"only_on_change": True,
"remove_blanks": True,
"retry": {
"max_retries": 3,
"requests_per_minute": 3000,
"retry_on_failure": True,
"timeout_seconds": 300
},
"typecast": True,
"update_mode": "patch"
},
"record_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
definition: {
fields: [
{
destination_field: '<string>',
source: {template: {format: 'plain', segments: [{text: '<string>', type: 'text'}]}},
skip_if_blank: true
}
],
integration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
integration_type: '<string>',
record_type: '<string>',
action: 'upsert',
batched: false,
identity: [
{
destination_field: '<string>',
source: {template: {format: 'plain', segments: [{text: '<string>', type: 'text'}]}}
}
],
kind: 'export',
only_on_change: true,
remove_blanks: true,
retry: {
max_retries: 3,
requests_per_minute: 3000,
retry_on_failure: true,
timeout_seconds: 300
},
typecast: true,
update_mode: 'patch'
},
record_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
table_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.getoneprofile.ai/table-writeback/preview/', 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.getoneprofile.ai/table-writeback/preview/",
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([
'definition' => [
'fields' => [
[
'destination_field' => '<string>',
'source' => [
'template' => [
'format' => 'plain',
'segments' => [
[
'text' => '<string>',
'type' => 'text'
]
]
]
],
'skip_if_blank' => true
]
],
'integration_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'integration_type' => '<string>',
'record_type' => '<string>',
'action' => 'upsert',
'batched' => false,
'identity' => [
[
'destination_field' => '<string>',
'source' => [
'template' => [
'format' => 'plain',
'segments' => [
[
'text' => '<string>',
'type' => 'text'
]
]
]
]
]
],
'kind' => 'export',
'only_on_change' => true,
'remove_blanks' => true,
'retry' => [
'max_retries' => 3,
'requests_per_minute' => 3000,
'retry_on_failure' => true,
'timeout_seconds' => 300
],
'typecast' => true,
'update_mode' => 'patch'
],
'record_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'table_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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://api.getoneprofile.ai/table-writeback/preview/"
payload := strings.NewReader("{\n \"definition\": {\n \"fields\": [\n {\n \"destination_field\": \"<string>\",\n \"source\": {\n \"template\": {\n \"format\": \"plain\",\n \"segments\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ]\n }\n },\n \"skip_if_blank\": true\n }\n ],\n \"integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"integration_type\": \"<string>\",\n \"record_type\": \"<string>\",\n \"action\": \"upsert\",\n \"batched\": false,\n \"identity\": [\n {\n \"destination_field\": \"<string>\",\n \"source\": {\n \"template\": {\n \"format\": \"plain\",\n \"segments\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ]\n }\n }\n }\n ],\n \"kind\": \"export\",\n \"only_on_change\": true,\n \"remove_blanks\": true,\n \"retry\": {\n \"max_retries\": 3,\n \"requests_per_minute\": 3000,\n \"retry_on_failure\": true,\n \"timeout_seconds\": 300\n },\n \"typecast\": true,\n \"update_mode\": \"patch\"\n },\n \"record_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://api.getoneprofile.ai/table-writeback/preview/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"definition\": {\n \"fields\": [\n {\n \"destination_field\": \"<string>\",\n \"source\": {\n \"template\": {\n \"format\": \"plain\",\n \"segments\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ]\n }\n },\n \"skip_if_blank\": true\n }\n ],\n \"integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"integration_type\": \"<string>\",\n \"record_type\": \"<string>\",\n \"action\": \"upsert\",\n \"batched\": false,\n \"identity\": [\n {\n \"destination_field\": \"<string>\",\n \"source\": {\n \"template\": {\n \"format\": \"plain\",\n \"segments\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ]\n }\n }\n }\n ],\n \"kind\": \"export\",\n \"only_on_change\": true,\n \"remove_blanks\": true,\n \"retry\": {\n \"max_retries\": 3,\n \"requests_per_minute\": 3000,\n \"retry_on_failure\": true,\n \"timeout_seconds\": 300\n },\n \"typecast\": true,\n \"update_mode\": \"patch\"\n },\n \"record_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/table-writeback/preview/")
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 \"definition\": {\n \"fields\": [\n {\n \"destination_field\": \"<string>\",\n \"source\": {\n \"template\": {\n \"format\": \"plain\",\n \"segments\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ]\n }\n },\n \"skip_if_blank\": true\n }\n ],\n \"integration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"integration_type\": \"<string>\",\n \"record_type\": \"<string>\",\n \"action\": \"upsert\",\n \"batched\": false,\n \"identity\": [\n {\n \"destination_field\": \"<string>\",\n \"source\": {\n \"template\": {\n \"format\": \"plain\",\n \"segments\": [\n {\n \"text\": \"<string>\",\n \"type\": \"text\"\n }\n ]\n }\n }\n }\n ],\n \"kind\": \"export\",\n \"only_on_change\": true,\n \"remove_blanks\": true,\n \"retry\": {\n \"max_retries\": 3,\n \"requests_per_minute\": 3000,\n \"retry_on_failure\": true,\n \"timeout_seconds\": 300\n },\n \"typecast\": true,\n \"update_mode\": \"patch\"\n },\n \"record_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"table_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"rows": [
{
"error": "<string>",
"identity": {},
"matched_record_id": "<string>",
"properties": {},
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"skipped_reason": "<string>",
"would": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
HTTPBearerAPIKeyHeader
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
A dry run: render an export against real rows, write nothing.
The export definition to preview — passed inline so the editor can preview BEFORE the column exists.
Show child attributes
Show child attributes
The rows to preview; the server caps how many render.
Required array length:
1 - 25 elementsResponse
Successful Response
The dry run's rows. Counters are absent on purpose: nothing ran.
Show child attributes
Show child attributes
Was this page helpful?