CLI for the FoxReach cold email outreach API
Project description
FoxReach CLI
Command-line interface for the FoxReach cold email outreach API.
Installation
pip install foxreach-cli
Setup
# Save your API key
foxreach config set-key
# Enter: otr_your_api_key
# Verify
foxreach config show
You can also use environment variables:
export FOXREACH_API_KEY=otr_your_api_key
export FOXREACH_BASE_URL=https://api.foxreach.io/api/v1 # optional
Usage
Leads
foxreach leads list
foxreach leads list --search "jane" --status active
foxreach leads get cld_abc123
foxreach leads create --email jane@example.com --first-name Jane --company "Acme"
foxreach leads update cld_abc123 --company "New Corp"
foxreach leads delete cld_abc123
Campaigns
foxreach campaigns list
foxreach campaigns list --status active
foxreach campaigns get cmp_xyz789
foxreach campaigns create --name "Q1 Outreach" --daily-limit 100
foxreach campaigns update cmp_xyz789 --daily-limit 200
foxreach campaigns start cmp_xyz789
foxreach campaigns pause cmp_xyz789
foxreach campaigns add-leads cmp_xyz789 --lead-ids cld_1,cld_2,cld_3
foxreach campaigns add-accounts cmp_xyz789 --account-ids acc_1
foxreach campaigns delete cmp_xyz789
Sequences
foxreach sequences list --campaign cmp_xyz789
foxreach sequences create --campaign cmp_xyz789 --subject "Hi {{firstName}}" --body "Hello!"
foxreach sequences update --campaign cmp_xyz789 --sequence seq_1 --delay-days 3
foxreach sequences delete --campaign cmp_xyz789 --sequence seq_1
Templates
foxreach templates list
foxreach templates get tpl_abc123
foxreach templates create --name "Follow-up" --body "Hi {{firstName}}, just checking in."
foxreach templates update tpl_abc123 --name "New Follow-up"
foxreach templates delete tpl_abc123
Email Accounts
foxreach accounts list
foxreach accounts get acc_abc123
foxreach accounts delete acc_abc123
Inbox
foxreach inbox list
foxreach inbox list --unread --category interested
foxreach inbox get rpl_abc123
foxreach inbox update rpl_abc123 --read --category qualified
Analytics
foxreach analytics overview
foxreach analytics campaign cmp_xyz789
JSON Output
Add --json to any command to get raw JSON output for scripting:
foxreach leads list --json | jq '.data[].email'
foxreach campaigns get cmp_xyz789 --json
Configuration
Config is stored at ~/.foxreach/config.json. Environment variables take precedence:
| Setting | Env Var | Config Key |
|---|---|---|
| API Key | FOXREACH_API_KEY |
api_key |
| Base URL | FOXREACH_BASE_URL |
base_url |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
foxreach_cli-0.2.0.tar.gz
(10.6 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file foxreach_cli-0.2.0.tar.gz.
File metadata
- Download URL: foxreach_cli-0.2.0.tar.gz
- Upload date:
- Size: 10.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
00c646b2c9db8a277cc670d8ce8131a8a5f9ca116429e23c908c3fb378a03bb8
|
|
| MD5 |
b39777a43433b5a83f7f6ab258c815b1
|
|
| BLAKE2b-256 |
7963868ed08d30abf2327fcdfaafd4dd2ba5e2787cf0136079eb650028413e89
|
File details
Details for the file foxreach_cli-0.2.0-py3-none-any.whl.
File metadata
- Download URL: foxreach_cli-0.2.0-py3-none-any.whl
- Upload date:
- Size: 17.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
45978281727b66fc759e78eceba67907ff72496187d366e424b24729981aec79
|
|
| MD5 |
05d1f080c09b233da3615ca2d002dbca
|
|
| BLAKE2b-256 |
223ad01cce30238f7fce388de664d6c3a7e98a0b81c1f66f089b78c74812d587
|