Overview

Vendor commands

Commands vendors use to manage their partner program
View as Markdown

Commands vendors use to manage their partner program. Commands are grouped by the object they act on.

Partners

jazzhq-cli invite-partner

Invite a new partner.

FlagRequiredDescription
--company-nameyesPartner’s company name
--contact-nameyesPrimary contact’s full name
--contact-email-addressyesPrimary contact’s email address
--contact-phonenoPrimary contact’s phone number
--typenoOne of “RESELLER, DISTRIBUTOR`
--api-keynoOverrides JAZZHQ_API_KEY
--base-urlnoOverrides JAZZHQ_API_BASE_URL
$jazzhq-cli invite-partner \
>  --company-name "Acme Inc" \
>  --contact-name "Jane Doe" \
>  --contact-email-address "jane@acme.com" \
>  --type RESELLER

jazzhq-cli reinvite-partner

Resend an invite email to an existing partner.

Argument / FlagRequiredDescription
partner_id (positional)yesThe partner’s ID
--email-addressyesEmail address to resend the invite to
--api-keynoOverrides JAZZHQ_API_KEY
--base-urlnoOverrides JAZZHQ_API_BASE_URL
$jazzhq-cli reinvite-partner 1001 --email-address "jane@acme.com"

jazzhq-cli list-partners

List partners connected to your vendor account.

FlagRequiredDefaultDescription
--pageno0Page number
--per-pageno20Results per page
--sort-bynoidField to sort by
--api-keynoOverrides JAZZHQ_API_KEY
--base-urlnoOverrides JAZZHQ_API_BASE_URL
$jazzhq-cli list-partners --page 0 --per-page 20

Leads, Contacts, Accounts, Deals, Commissions, Assets

Commands for these objects will appear here as they ship.