Salesforce Marketing Cloud API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "salesforce_marketing_cloud",
"trust_certificates": true,
"trust_fingerprints": true,
"run_setup_tests": true,
"paused": false,
"pause_after_trial": false,
"sync_frequency": 1440,
"data_delay_sensitivity": "NORMAL",
"data_delay_threshold": 0,
"daily_sync_time": "14:00",
"schedule_type": "auto",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"sftp_is_key_pair": true,
"sftp_user": "string",
"instance": "string",
"sftp_port": 0,
"sftp_host": "string",
"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"is_new_package": true,
"sync_mode": "AllEvents | SelectedEvents",
"historic_sync_time_frame": "THREE_MONTHS | SIX_MONTHS | ONE_YEAR | TWO_YEARS | FIVE_YEARS | ALL_TIME",
"historical_sync_limit_date": "2000-12-15",
"historical_sync_limit": "ALL_TIME | DATE_LIMIT",
"is_sftp_creds_available": true,
"sub_domain": "http://your.sub.domain/",
"client_secret": "your_api_secret",
"selected_event_types": [
"string"
],
"sftp_password": "string",
"schema": "schema_name"
}
}Config parameters
| Name | Description |
|---|---|
sftp_is_key_pair | Set this field if you use a key pair for logging into your SFTP server. Don't set it if you use a username and password |
sftp_user | User |
instance | The Salesforce Marketing Cloud instance ID |
sftp_port | Port |
sftp_host | Host |
client_id | The Salesforce Marketing Cloud client ID. |
is_new_package | Indicates that that your installed package uses OAuth 2.0. Default value: false |
sync_mode | Select the sync mode. |
historic_sync_time_frame | Range of data in history you would like to include in the initial sync. Default value: ALL_TIME. |
historical_sync_limit_date | The start date (YYYY-MM-DD) from which to sync historical data. |
historical_sync_limit | The time range for which historical data should be synced. Default value: All Time. |
is_sftp_creds_available | Provide SFTP credentials |
sub_domain | Your Salesforce Marketing Cloud subdomain. |
client_secret | The Salesforce Marketing Cloud client secret. |
selected_event_types | Select the event types to be synced. |
sftp_password | Password |
schema | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_id,client_secretandinstanceparameters in the request.POST https://api.fivetran.com/v1/connections{ "service": "salesforce_marketing_cloud", "group_id": "group_id", "config": { "client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "client_secret": "your_api_secret", "instance": "string" } }By using the Connect Card or the Fivetran dashboard.