Upland Software API Configuration Lite

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "upland",
  "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,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "api_key": "your_upland_api_key",
    "auth_type": "api_key",
    "company_key": "your_upland_company_key",
    "password": "your_upland_password",
    "sub_domain": "your_upland_sub_domain",
    "username": "your_upland_username",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`api_key`	Your Upland Software API key.
`auth_type`	Authentication method you want to use for your connection.
`company_key`	Your Upland Software company key.
`password`	Your Upland Software password.
`sub_domain`	Your Upland Software subdomain.
`username`	Your Upland Software username.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

API Key or Basic Auth: By specifying the auth_type as "api_key or basic" and the values for the sub_domain, company_key, username, password and api_key parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "upland",
  "group_id": "group_id",
  "config": {
    "sub_domain": "your_upland_sub_domain",
    "company_key": "your_upland_company_key",
    "username": "your_upland_username",
    "password": "your_upland_password",
    "api_key": "your_upland_api_key",
    "auth_type": "api_key or basic"
  }
}

By using the Connect Card or the Fivetran dashboard.