Zoho People 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": "zoho_people",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "LOW",
  "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": {
    "client_id": "your_application_client_id",
    "client_secret": "your_application_client_secret",
    "region": "com",
    "schema": "schema_name"
  },
  "auth": {
    "access_token": "string",
    "client_access": {
      "client_id": "string",
      "client_secret": "string"
    },
    "refresh_token": "string"
  }
}

Config parameters

Name	Description
`client_id`	The client ID of the application that is registered in your Zoho People developer account for this connection.
`client_secret`	The client secret of the application that is registered in your Zoho People developer account for this connection.
`region`	The region where the application that is registered in your Zoho People developer account is hosted.
`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:

By specifying the values for the client_id, client_secret and region parameters in the request.

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

{
  "service": "zoho_people",
  "group_id": "group_id",
  "config": {
    "client_id": "your_application_client_id",
    "client_secret": "your_application_client_secret",
    "region": "com"
  }
}

By using the Connect Card or the Fivetran dashboard.