Email API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "email",
  "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",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "SOURCE_NAMING",
  "config": {
    "append_file_option": "upsert_file_with_primary_keys | append_file",
    "quote_character_enabled": true,
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "selected_range": "'Sheet1'!A1",
    "pattern": "file_pattern",
    "escape_char": "string",
    "json_delivery_mode": "Packed | Unpacked",
    "skip_after": 0,
    "quote_char": "string",
    "line_separator": ";",
    "empty_header": true,
    "skip_before": 0,
    "null_sequence": "string",
    "file_type": "tsv | xml | csv | spreadsheet | json | jsonl | avro | parquet",
    "delimiter": "string",
    "files": [
      {
        "file_pattern": "string",
        "table_name": "string",
        "email_subject": "string",
        "archive_pattern": "string"
      }
    ],
    "compression": "zip | gz | tar_gz | tar | infer | gzip | uncompressed | bz2 | tar_bz2",
    "archive_pattern": "regex_pattern",
    "schema": "schema_name",
    "table_group_name": "string"
  }
}

Config parameters

Name	Description
`append_file_option`	If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number.
`quote_character_enabled`	If you don’t want to use an enclosing character while processing the files, set the value to false. By default, the value is set to true and is considered " as quote character.
`connection_type`	Connection method. Default value: `Directly`.
`selected_range`	Cell reference that will be used to sync all contiguous data starting from the top-left cell in all the spreadsheets matching the name. Cell reference is in the `'<sheetName>'!<startColumnName><startRowName>` format.
`pattern`	All files in your search path matching this regular expression will be synced. We have discontinued this field, and will delete it by Oct 31, 2025.
`escape_char`	If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here.
`json_delivery_mode`	Control how your JSON data is delivered into your destination
`skip_after`	We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination.
`quote_char`	You can specify the enclosing character used in your CSVs here. Fivetran will consider " as the quote character if this field is empty and quote_character_enabled is set to true.
`line_separator`	You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next.
`empty_header`	Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them.
`skip_before`	We will skip over the number of lines specified before syncing data.
`null_sequence`	If your CSVs use a special value indicating null, you can specify it here.
`file_type`	If your files are saved with improper extensions, you can force them to by synced as the selected file type.
`delimiter`	You can specify your the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible.
`files`	Mapped file name patterns to a destination table.
`files[0].file_pattern`	All files in your search path matching this regular expression will be synced per table.
`files[0].table_name`	All files matching the above pattern will be synced to this table.
`files[0].email_subject`	Only attachments from emails with this subject will be synced. Leave this field blank to sync all attachments.
`files[0].archive_pattern`	All Files inside of compressed archives with filenames matching this regular expression will be synced.
`compression`	The secrets that should be passed to the function at runtime.
`archive_pattern`	Files inside of compressed archives with filenames matching this regular expression will be synced.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation
`table_group_name` (required)	Combined with the schema to form the Fivetran connection name `<schema>.<table_group_name>`. Lets you create multiple Merge Mode connections per schema.

Authorization

This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.