v1
latestOpenAPI 3.0.32026-08-06138294578.6 KBBulk Sync
Get Bulk Destination
Describes the destination configuration schema a connection accepts when used as a bulk sync destination.
The response is a JSON Schema object describing the shape of the destination_configuration field you must supply when creating or updating a bulk sync that uses this connection as its destination. Required fields vary by connection type.
📘 Fetch this endpoint once per connection type rather than once per sync. The configuration schema is the same for all syncs sharing the same destination connection.
get/api/connections/{id}/bulksync/target
Path parameters
idstring uuid required
Example:248df4b7-aa70-47b8-a036-33ac447e668d
Headers
X-Polytomic-Versionstring
Response
OK
Example response
{
"data": {
"configuration": {
"advanced": {
"items": {
"truncate_existing": {
"default": "",
"items": null,
"required": false
}
}
},
"mirror_schemas": {
"default": "",
"items": null,
"required": false
},
"schema": {
"default": "",
"items": null,
"required": false
}
},
"modes": [
{
"description": "Replace all records",
"label": "Replace"
}
]
}
}