> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.jazzhq.ai/cli/vendor-commands/partners/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.jazzhq.ai/_mcp/server. # Partner commands Commands for the partners connected to your vendor account, as `jazzhq-cli partner `. ## `jazzhq-cli partner invite` Invite a new partner. | Flag | Required | Description | | ------------------------- | -------- | ------------------------------------------------------------------------------------------------ | | `--company-name` | yes | Partner's company name | | `--contact-name` | yes | Primary contact's full name | | `--contact-email-address` | yes | Primary contact's email address | | `--description` | no | Short description of the partner | | `--website` | no | Partner's website | | `--country` | no | Partner's country | | `--company-size` | no | Partner's company size, e.g. `50-100` | | `--contact-phone` | no | Primary contact's phone number | | `--contact-role` | no | Primary contact's job title | | `--type` | no | One of `REFERRAL_PARTNER`, `AFFILIATE_PARTNER`, `RESELLER`, `DISTRIBUTOR` | | `--user` | no | A person to invite inside the partner company, as comma-separated `key=value` pairs. Repeatable. | | `--users-json` | no | A JSON array of user objects, instead of `--user` | | `--api-key` | no | Overrides `JAZZHQ_API_KEY` | | `--base-url` | no | Overrides `JAZZHQ_API_BASE_URL` | ```bash 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. ```bash 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" ``` > **Note** > > 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 / Flag | Required | Description | | ------------------------- | -------- | ------------------------------------- | | `partner_id` (positional) | yes | The partner's ID | | `--email-address` | yes | Email address to resend the invite to | | `--api-key` | no | Overrides `JAZZHQ_API_KEY` | | `--base-url` | no | Overrides `JAZZHQ_API_BASE_URL` | ```bash jazzhq-cli partner reinvite 1001 --email-address "jane@acme.com" ``` ## `jazzhq-cli partner list` List partners connected to your vendor account. | Flag | Required | Default | Description | | ------------ | -------- | ------- | ------------------------------- | | `--page` | no | `0` | Page number | | `--per-page` | no | `20` | Results per page | | `--sort-by` | no | `id` | Field to sort by | | `--api-key` | no | | Overrides `JAZZHQ_API_KEY` | | `--base-url` | no | | Overrides `JAZZHQ_API_BASE_URL` | ```bash 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 / Flag | Required | Description | | ------------------------- | -------- | --------------------------------------------------------------------- | | `partner_id` (positional) | yes | The partner's ID | | `--user` | yes\* | A person to invite, as comma-separated `key=value` pairs. Repeatable. | | `--users-json` | yes\* | A JSON array of user objects, instead of `--user` | | `--api-key` | no | Overrides `JAZZHQ_API_KEY` | | `--base-url` | no | Overrides `JAZZHQ_API_BASE_URL` | \* Provide one of `--user` or `--users-json`, not both. ```bash jazzhq-cli partner add-users 1001 \ --user "firstName=Raj,emailAddress=raj@acme.com,jobTitle=Account Executive" \ --user "firstName=Mia,emailAddress=mia@acme.com" ``` > **Note** > > 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: ```bash 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 / Flag | Required | Default | Description | | ------------------------- | -------- | ------- | ----------------------------------------------------------------------------- | | `partner_id` (positional) | yes | | The partner's ID | | `--page` | no | `0` | Page number | | `--per-page` | no | `20` | Results per page | | `--sort-by` | no | `id` | One of `id`, `firstName`, `lastName`, `emailAddress`, `jobTitle`, `createdAt` | | `--api-key` | no | | Overrides `JAZZHQ_API_KEY` | | `--base-url` | no | | Overrides `JAZZHQ_API_BASE_URL` | ```bash 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. > Invite partners, manage their users, and see who is connected