Hightouch CLI

The Paradime SDK provides CLI commands to interact with Hightouch, allowing you to trigger syncs and sync sequences, and list available syncs and sync sequences with their status.

🔑 API Access RequiredYou will need a Hightouch API token to use these commands. You can create this in your Hightouch workspace settings.You can set your token as the HIGHTOUCH_API_TOKEN environment variable so you don’t have to pass --api-token on every command.

Trigger Hightouch Syncs

Trigger syncs for Hightouch.

CLI Command

paradime run hightouch-sync

Options

Flag	Type	Description
`--api-token`	Required, TEXT	Your Hightouch API token. You can create this in your Hightouch workspace settings. `[env: HIGHTOUCH_API_TOKEN]`
`--sync-ids`	Required, TEXT (comma-separated)	Comma-separated sync ID(s) to trigger
`--full-resync`	Optional, Flag	Resync all rows in the query, ignoring previously synced rows. Default: `False`.
`--wait` / `--no-wait`	Optional, Flag	Wait for syncs to complete before returning (default: True) `[env: HIGHTOUCH_SYNC_WAIT]`
`--timeout`	Optional, INTEGER	Maximum time to wait in minutes. Default: `1440`. `[env: HIGHTOUCH_SYNC_TIMEOUT]`
`--json`	Optional, Flag	Output results as JSON. Default: `False`.
`--help`	Optional, Flag	Show the help message and exit.

Examples

# Using the HIGHTOUCH_API_TOKEN environment variable (recommended)
paradime run hightouch-sync --sync-ids "12345,67890"

# Force a full resync
paradime run hightouch-sync \
  --sync-ids "12345" \
  --full-resync

# With an explicit API token
paradime run hightouch-sync \
  --api-token "your_hightouch_api_token" \
  --sync-ids "12345"

Trigger Hightouch Sync Sequences

Trigger sync sequences for Hightouch.

CLI Command

paradime run hightouch-sync-sequence

Options

Flag	Type	Description
`--api-token`	Required, TEXT	Your Hightouch API token. You can create this in your Hightouch workspace settings. `[env: HIGHTOUCH_API_TOKEN]`
`--sync-sequence-ids`	Required, TEXT (comma-separated)	Comma-separated sync sequence ID(s) to trigger
`--wait` / `--no-wait`	Optional, Flag	Wait for sync sequences to complete before returning (default: True) `[env: HIGHTOUCH_SYNC_SEQUENCE_WAIT]`
`--timeout`	Optional, INTEGER	Maximum time to wait in minutes. Default: `1440`. `[env: HIGHTOUCH_SYNC_SEQUENCE_TIMEOUT]`
`--json`	Optional, Flag	Output results as JSON. Default: `False`.
`--help`	Optional, Flag	Show the help message and exit.

Examples

# Trigger a single sync sequence
paradime run hightouch-sync-sequence --sync-sequence-ids "seq_12345"

# Trigger multiple sync sequences without waiting for completion
paradime run hightouch-sync-sequence \
  --sync-sequence-ids "seq_12345,seq_67890" \
  --no-wait

List Hightouch Syncs

List all available Hightouch syncs with their status.

CLI Command

paradime run hightouch-list-syncs

Options

Flag	Type	Description
`--api-token`	Required, TEXT	Your Hightouch API token. You can create this in your Hightouch workspace settings. `[env: HIGHTOUCH_API_TOKEN]`
`--json`	Optional, Flag	Output results as JSON. Default: `False`.
`--help`	Optional, Flag	Show the help message and exit.

Examples

# List all Hightouch syncs
paradime run hightouch-list-syncs

# Output as JSON
paradime run hightouch-list-syncs --json

List Hightouch Sync Sequences

List all available Hightouch sync sequences with their status.

CLI Command

paradime run hightouch-list-sync-sequences

Options

Flag	Type	Description
`--api-token`	Required, TEXT	Your Hightouch API token. You can create this in your Hightouch workspace settings. `[env: HIGHTOUCH_API_TOKEN]`
`--json`	Optional, Flag	Output results as JSON. Default: `False`.
`--help`	Optional, Flag	Show the help message and exit.

Examples

# List all Hightouch sync sequences
paradime run hightouch-list-sync-sequences

# Output as JSON
paradime run hightouch-list-sync-sequences --json

Environment Variable Reference

Environment Variable	Description
`HIGHTOUCH_API_TOKEN`	Your Hightouch API token
`HIGHTOUCH_SYNC_WAIT`	Whether to wait for syncs to complete (`hightouch-sync`)
`HIGHTOUCH_SYNC_TIMEOUT`	Maximum time to wait in minutes (`hightouch-sync`)
`HIGHTOUCH_SYNC_SEQUENCE_WAIT`	Whether to wait for sync sequences to complete (`hightouch-sync-sequence`)
`HIGHTOUCH_SYNC_SEQUENCE_TIMEOUT`	Maximum time to wait in minutes (`hightouch-sync-sequence`)

API Keys & Access

GraphQL API

Python SDK

Paradime CLI

Webhooks

Virtual Environments

Trigger Hightouch Syncs

CLI Command

Examples

Trigger Hightouch Sync Sequences

CLI Command

Examples

List Hightouch Syncs

CLI Command

Examples

List Hightouch Sync Sequences

CLI Command

Examples

Environment Variable Reference

​Trigger Hightouch Syncs

​CLI Command

​Examples

​Trigger Hightouch Sync Sequences

​CLI Command

​Examples

​List Hightouch Syncs

​CLI Command

​Examples

​List Hightouch Sync Sequences

​CLI Command

​Examples

​Environment Variable Reference

Trigger Hightouch Syncs

CLI Command

Examples

Trigger Hightouch Sync Sequences

CLI Command

Examples

List Hightouch Syncs

CLI Command

Examples

List Hightouch Sync Sequences

CLI Command

Examples

Environment Variable Reference