# HeyZack Partner Portal

> Documentation for the HeyZack Partner Portal smart home operations platform.

## Partner Portal documentation

- [Sign in, reset, and manage your Partner Portal account](https://docs.heyzack.ai/docs/authentication): How to sign in to the HeyZack Partner Portal, reset a forgotten password, set a permanent password on first login, and manage your account security.
- [HeyZack Partner Portal: Smart Home Operations Hub](https://docs.heyzack.ai/docs): HeyZack Partner Portal helps authorized smart home installers manage customers, installations, and handymen from a single dashboard.
- [HeyZack Partner Portal: Smart Home Operations Hub](https://docs.heyzack.ai/docs/introduction): HeyZack Partner Portal helps authorized smart home installers manage customers, installations, and handymen from a single dashboard.
- [Get started with the HeyZack Partner Portal](https://docs.heyzack.ai/docs/quickstart): Learn how to sign in to the HeyZack Partner Portal and get oriented with your dashboard and key sections.
- [View customer records and installation history](https://docs.heyzack.ai/docs/customers/managing-customers): How to open customer records, review full contact details, inspect timelines, and track installation history.
- [Customer records in the HeyZack Partner Portal](https://docs.heyzack.ai/docs/customers/overview): Learn what customer records contain, how to browse and filter your customer list, and how to navigate from records to full installation history.
- [Understanding your dashboard KPIs and metrics](https://docs.heyzack.ai/docs/dashboard/kpis): A breakdown of each KPI card on your dashboard — what it measures, how it is calculated, and what to do when a number looks off.
- [Partner Portal dashboard: your operations at a glance](https://docs.heyzack.ai/docs/dashboard/overview): The dashboard shows live KPI cards, upcoming installations, and recent customers so you can monitor your business and act without navigating multiple sections.
- [Partner tiers: benefits, revenue thresholds, and credits](https://docs.heyzack.ai/docs/dashboard/partner-tier): How the HeyZack partner tier system works — tier thresholds, discount and MDF rates, partner credits, and how to apply credits to a Shopify order.
- [Track and view handyman availability schedules](https://docs.heyzack.ai/docs/handymen/availability): View a handyman's daily availability slots, understand status indicators, and see how job assignments affect their availability in real time.
- [Send messages to handymen directly from the portal](https://docs.heyzack.ai/docs/handymen/messaging): Use the built-in messaging modal to send text messages and images to any handyman in your team, without leaving the Partner Portal.
- [Manage your handyman team in the Partner Portal](https://docs.heyzack.ai/docs/handymen/overview): Add, search, filter, and remove handymen linked to your partner account, and view their skills, availability, and verification status.
- [Assign and reassign handymen to installation jobs](https://docs.heyzack.ai/docs/installations/handyman-assignment): Assign a verified handyman to an open installation, reassign when plans change, and understand how assignment affects the installation status.
- [Installation management in the Partner Portal](https://docs.heyzack.ai/docs/installations/overview): View, search, and manage every smart home installation your business handles — from scheduling through customer approval — in one place.
- [Schedule smart home installations for your customers](https://docs.heyzack.ai/docs/installations/scheduling): Book a new installation, set the date and time, add notes, and optionally assign a handyman — all from the Schedule Installation form.
- [Installation status workflow from scheduled to approved](https://docs.heyzack.ai/docs/installations/statuses): Understand every installation status, how they group together in the portal overview, and which statuses allow actions like assigning or rejecting.
- [Order smart home devices through the Partner Portal](https://docs.heyzack.ai/docs/inventory/overview): Understand the Orders page: view your order history, monitor statuses, search and filter orders, and access the HeyZack storefront.
- [Place and track smart home device orders](https://docs.heyzack.ai/docs/inventory/placing-orders): Learn how to shop on the HeyZack storefront, apply partner credits at checkout, and track your orders through every stage of fulfilment.
- [Financial reports: revenue, tier, and sales data](https://docs.heyzack.ai/docs/reports/financial-reports): Review your revenue by source, profit margins, payment aging, partner commissions, and customer satisfaction scores for any date range.
- [Installation performance reports and analytics](https://docs.heyzack.ai/docs/reports/installation-reports): Track total installations, completion rates, average job time, and daily trends to understand your installation pipeline's operational health.
- [Analytics and reporting for your partner business](https://docs.heyzack.ai/docs/reports/overview): The Reports section covers installation activity, revenue, handyman performance, and customer satisfaction. Filter by date range and export data for any period.
- [Change your Partner Portal account password](https://docs.heyzack.ai/docs/settings/password): Change your Partner Portal login password from the Settings page. Covers the password change form, requirements, forgot password, and first-login reset.
- [Update your partner profile and company details](https://docs.heyzack.ai/docs/settings/profile): Edit your company name, address, and phone number from the Settings page. Your email address is read-only and must be updated by contacting HeyZack support.

## HeyZack CRM documentation

- [Authenticate with the Heyzack CRM](https://docs.heyzack.ai/docs/crm/authentication): Learn how to sign in to the CRM, obtain a bearer token for API access, and handle token expiry and common authentication errors.
- [Heyzack CRM: frequently asked questions](https://docs.heyzack.ai/docs/crm/faq): Answers to common questions about accounts, roles, chat, leads, referral tokens, and portal features in the Heyzack CRM.
- [Heyzack Partner Portal: Smart Home Installation CRM](https://docs.heyzack.ai/docs/crm): The Heyzack CRM helps you manage smart home installations, partners, handymen, leads, payments, and your team from one dashboard.
- [Heyzack CRM: smart home operations hub](https://docs.heyzack.ai/docs/crm/introduction): A web-based CRM and operations dashboard for managing smart home installations, leads, partners, payments, and your entire field team.
- [Get started with the Heyzack CRM](https://docs.heyzack.ai/docs/crm/quickstart): Sign in, explore the dashboard, create your first installation, add a lead, and set up your team — everything you need to hit the ground running.
- [Troubleshooting common issues in the portal](https://docs.heyzack.ai/docs/crm/troubleshooting): Step-by-step solutions for login problems, real-time chat issues, missing installations, lead status errors, and other common Heyzack portal issues.
- [Authenticate API requests with Bearer tokens](https://docs.heyzack.ai/docs/crm/api/authentication): Learn how to obtain your Bearer token after signing in to the Heyzack Partner Portal and how to pass it correctly in every API request.
- [Heyzack CRM REST API overview](https://docs.heyzack.ai/docs/crm/api/overview): Learn the base URL, versioning scheme, request and response format, authentication header, and HTTP status codes for the Heyzack CRM API.
- [Understanding the installation lifecycle](https://docs.heyzack.ai/docs/crm/concepts/installation-lifecycle): Learn the stages a smart home installation moves through in the CRM, from initial draft to customer approval or cancellation.
- [Partners and handymen: roles in the network](https://docs.heyzack.ai/docs/crm/concepts/partners-handymen): Understand the difference between partners and handymen in the CRM, how they relate to installations, and how they communicate.
- [Roles and permissions in the CRM](https://docs.heyzack.ai/docs/crm/concepts/roles-permissions): Learn how Admin, Manager, and Support roles work in the Heyzack CRM, and how to control which menu sections each user can access.
- [Activity logs: audit every action in the portal](https://docs.heyzack.ai/docs/crm/features/activity-logs): Review a timestamped record of every user action in the portal — from logins and status changes to payout creation and team management events.
- [Real-time chat with partners and handymen](https://docs.heyzack.ai/docs/crm/features/chat): Send and receive real-time messages with partners, handymen, and admins in the Heyzack CRM — with support for text and image attachments.
- [Dashboard: your smart home operations overview](https://docs.heyzack.ai/docs/crm/features/dashboard): Get a real-time snapshot of sales, leads, installations, partners, and recent orders the moment you open the Heyzack CRM.
- [Manage smart home installations end-to-end](https://docs.heyzack.ai/docs/crm/features/installations): Search, filter, create, and track every smart home installation from initial scheduling through to customer approval using the Heyzack CRM.
- [Track, qualify, and convert leads to customers](https://docs.heyzack.ai/docs/crm/features/leads): Capture and manage potential customers in the Heyzack CRM — qualify leads, generate partner referral tokens, and convert them to orders.
- [Orders and sales reporting in the portal](https://docs.heyzack.ai/docs/crm/features/orders): View, create, and update customer orders and analyse revenue trends with date-range filters, partner breakdowns, and CSV export in the CRM.
- [Process and track partner commission payouts](https://docs.heyzack.ai/docs/crm/features/payments): Create, filter, and track partner commission payouts by status, partner, and date range from the Heyzack crm Payments section.
- [Configure menu access permissions per user](https://docs.heyzack.ai/docs/crm/user-management/permissions): Control which portal sections each Manager or Support user can see by enabling or disabling individual menu permissions when creating their account.
- [Create, edit, and delete portal user accounts](https://docs.heyzack.ai/docs/crm/user-management/users-roles): Learn how to create user accounts, assign Admin, Manager, or Support roles, edit roles, and remove users from the Heyzack CRM.
- [GET /api/v1/chat/connections — list contacts](https://docs.heyzack.ai/docs/crm/api/chat/connections): Retrieve all users available to chat with in the Heyzack Partner Portal. Response shape adapts to your role — partner, handyman, or admin.
- [GET /api/v1/chat/history — retrieve messages](https://docs.heyzack.ai/docs/crm/api/chat/history): Fetch paginated, chronological message history between you and a specific partner, handyman, or admin using the Heyzack Partner Portal Chat API.
- [POST /api/v1/chat/send — send a chat message](https://docs.heyzack.ai/docs/crm/api/chat/send-message): Send a text message to a partner, handyman, or admin using the Heyzack Chat API. Exactly one recipient ID must be provided per request.
- [POST /api/v1/chat/upload-image — send an image](https://docs.heyzack.ai/docs/crm/api/chat/upload-image): Upload a JPEG, PNG, WebP, or GIF image and send it as a chat message to a partner, handyman, or admin via the Heyzack Partner Portal API.

## Links

- [Support](mailto:heyzackai@gmail.com)