PATCH /v1/connections/{connectionId}/schemas/{schemaName}/tables/{tableName}

Updates the table config within your database schema for an existing connection within your Fivetran account

Servers

Path parameters

Name Type Required Description
schemaName String Yes

The database schema name within your destination (different from the connection schema)

tableName String Yes

The table name within your database schema

connectionId String Yes

The unique identifier for the connection within the Fivetran system

Request headers

Name Type Required Description
Accept String No

Default value: "application/json"

Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
enabled Boolean Yes

The boolean value specifying whether the sync for the table into the destination is enabled.

columns Object No

The set of columns within your table schema config. The columns object in the response contains the columns whose enabled value has been set by the user after the initial sync.

columns.column Object No
columns.column.hashed Boolean No

The boolean value specifying whether a column should be hashed

columns.column.enabled Boolean Yes

The boolean value specifying whether the sync for the table into the destination is enabled.

columns.column.is_primary_key Boolean No
columns.column.masking_algorithm String No

Possible values:

  • "ENCRYPTED"
  • "HASHED"
  • "PLAINTEXT"
sync_mode String No

This field appears in the response if the connection supports switching sync modes for tables

Possible values:

  • "LIVE"
  • "SOFT_DELETE"
  • "HISTORY"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.