Skip to navigation
Vendor commands

Partner commands

Invite partners, manage their users, and see who is connected
View as MarkdownOpen in Claude

Commands for the partners connected to your vendor account, as jazzhq-cli partner <verb>.

jazzhq-cli partner invite

Invite a new partner.

FlagRequiredDescription
--company-nameyesPartner’s company name
--contact-nameyesPrimary contact’s full name
--contact-email-addressyesPrimary contact’s email address
--descriptionnoShort description of the partner
--websitenoPartner’s website
--countrynoPartner’s country
--company-sizenoPartner’s company size, e.g. 50-100
--contact-phonenoPrimary contact’s phone number
--contact-rolenoPrimary contact’s job title
--typenoOne of REFERRAL_PARTNER, AFFILIATE_PARTNER, RESELLER, DISTRIBUTOR
--usernoA person to invite inside the partner company, as comma-separated key=value pairs. Repeatable.
--users-jsonnoA JSON array of user objects, instead of --user
--api-keynoOverrides JAZZHQ_API_KEY
--base-urlnoOverrides JAZZHQ_API_BASE_URL
jazzhq-cli partner invite \
  --company-name "Acme Inc" \
  --contact-name "Jane Doe" \
  --contact-email-address "jane@acme.com" \
  --type RESELLER

To invite several people at once, repeat --user. Valid keys are firstName, lastName, emailAddress, phoneNumber, and jobTitle; firstName and emailAddress are required on each.

jazzhq-cli partner invite \
  --company-name "Acme Inc" \
  --contact-name "Jane Doe" \
  --contact-email-address "jane@acme.com" \
  --user "firstName=Jane,lastName=Doe,emailAddress=jane@acme.com,jobTitle=VP Sales" \
  --user "firstName=Raj,emailAddress=raj@acme.com"

Omit --user entirely and a single user is created from the contact fields.

jazzhq-cli partner reinvite

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 partner reinvite 1001 --email-address "jane@acme.com"

jazzhq-cli partner list

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 partner list --page 0 --per-page 20

jazzhq-cli partner add-users

Invite more people into a partner company already connected to your vendor account.

Argument / FlagRequiredDescription
partner_id (positional)yesThe partner’s ID
--useryes*A person to invite, as comma-separated key=value pairs. Repeatable.
--users-jsonyes*A JSON array of user objects, instead of --user
--api-keynoOverrides JAZZHQ_API_KEY
--base-urlnoOverrides JAZZHQ_API_BASE_URL

* Provide one of --user or --users-json, not both.

jazzhq-cli partner add-users 1001 \
  --user "firstName=Raj,emailAddress=raj@acme.com,jobTitle=Account Executive" \
  --user "firstName=Mia,emailAddress=mia@acme.com"

This is all-or-nothing. If any email address already belongs to a user, or the same address appears twice in one request, nothing is created and the command exits 1 with a DUPLICATE_ENTRY error naming the address.

--user splits values on commas, so use --users-json when a value contains one:

jazzhq-cli partner add-users 1001 \
  --users-json '[{"firstName":"Ann","emailAddress":"ann@acme.com","jobTitle":"VP, Sales"}]'

jazzhq-cli partner list-users

List the people inside a partner company.

Argument / FlagRequiredDefaultDescription
partner_id (positional)yesThe partner’s ID
--pageno0Page number
--per-pageno20Results per page
--sort-bynoidOne of id, firstName, lastName, emailAddress, jobTitle, createdAt
--api-keynoOverrides JAZZHQ_API_KEY
--base-urlnoOverrides JAZZHQ_API_BASE_URL
jazzhq-cli partner list-users 1001 --per-page 50

Each user includes lastActiveAt, which is null until they first sign in to the partner portal — useful for telling an outstanding invite from an active user.