Skip to navigation

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.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Polytomic-VersionstringRequired

Response

OK
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error