jazzhq-cli

Command-line tool for managing customer and partner data via the JazzHQ API.

Install

pip install jazzhq-cli

This puts a jazzhq-cli command on your PATH.

Configure

jazzhq-cli authenticates with a vendor API key, sent as the X-API-KEY header on every request. Set it, along with the API host, as environment variables:

export JAZZHQ_API_KEY="your-vendor-api-key"
export JAZZHQ_API_BASE_URL="https://api.jazzhq.ai"

Or override either one per-command with --api-key / --base-url, which take precedence over the environment variables:

jazzhq-cli list-partners --api-key "your-vendor-api-key" --base-url "https://api.jazzhq.ai"

If neither the environment variable nor the flag is set, the command exits with a configuration error before making any request.

Commands

Every command prints the raw JSON API response body to stdout on success. Errors go to stderr, including any field-level validation errors returned by the API.

All commands accept --api-key and --base-url as described above.

invite-partner

Invite a new partner.

jazzhq-cli invite-partner \
  --company-name "Acme Inc" \
  --contact-name "Jane Doe" \
  --contact-email-address "jane@acme.com" \
  --type RESELLER

The table above covers the commonly used fields. Run jazzhq-cli invite-partner --help for the full set of accepted options.

reinvite-partner

Resend an invite email to an existing partner.

jazzhq-cli reinvite-partner 1001 --email-address "jane@acme.com"

list-partners

List partners connected to your vendor account.

jazzhq-cli list-partners --page 0 --per-page 20

Exit codes

License

MIT