Sign in
latestOpenAPI 3.0.02026-08-137192110.1 KB

75294f591cc2

Reverse ETL Syncs

Get Reverse ETL Settings Schema for a connection

Get the settings for a connection, used when creating or updating a Reverse ETL Sync. The connection should already be created before getting the settings. Some settings have options that depend on other settings (e.g. the available sheets depend on the selected file URL) - provide the already-selected values via partial_settings to resolve those dependent options. This is a read-only operation - it does not create or modify a Reverse ETL Sync; POST is used so the (potentially large) partial_settings can be sent in the request body.

post/reverse_etl_syncs/settings_schema

Query parameters

connection_idstring required
Example:X4ughggABSd3UY

The ID of the (already created) destination connection.

object_typestring required
Example:contact

The ID of the object type to get the settings for (e.g. contact).

Request body

partial_settingsobject

A JSON object of already-selected setting values, used to resolve options that depend on other settings (e.g. {"url":"https://..."} to resolve the available sheets with the Excel integration).

Example request

{
  "partial_settings": {
    "url": "https://onedrive.live.com/..."
  }
}

Response

A JSON Schema (draft-07) describing the available settings and their constraints for the connection. The dependencies keyword maps a field name to a list of other field names that must be provided before that field's dependent options (e.g. its oneOf list) can be resolved - resolve those dependent options by providing the already-selected values via partial_settings in the request body.

$schemastring required
titlestring required
typestring required
propertiesobject required
requiredstring[]
dependenciesobject

Maps a field name to a list of other field names that must be provided before this field's dependent options (e.g. its oneOf list) can be resolved.

Example response

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Salesforce Settings",
  "type": "object"
}