User guide
Guided Setup
Looking for what it does rather than how to use it? Read the Guided setup overview .
Last verified against the codebase: 2026-08-30.
Guided setup is how a tenant sets itself up. It has three parts: the blueprint interview (“Set up my business”, also called MSP in a Box), which provisions an MSP’s whole operating model from a short interview and can be re-run at any time; the Getting Started checklist, a persistent hub in both the MSP and organization portals whose steps complete themselves from live data, lock behind plan tiers with an upgrade path, and trigger nudge emails when a workspace stalls; and guided tours, short in-app walkthroughs reachable from the checklist.
What it is
The blueprint interview turns six answers into a working service desk, catalogue and document set for an MSP, and the Getting Started checklist tracks everything else a workspace still needs to do, for MSPs and organizations alike. Neither is a one-shot wizard: the interview can be re-run to layer a second business model on later, and the checklist stays in the navigation until you dismiss it.
Concepts
| Concept | What it is |
|---|---|
| Blueprint | A named MSP business model. Six ship: solo (IT on the side), managed (Managed services), co-managed (Co-managed IT), security (Security-forward MSP), vcio (vCIO & consulting) and blank (Start from scratch). A blueprint selects content from a shared catalogue and supplies the interview’s defaults. It contains no logic. |
| Interview answers | Ten fields: team size, coverage, billing models, service areas, hourly rate, currency, country, time zone, “copy the agreement pack” and “apply this standard to new clients”. Every field has a blueprint-supplied default. |
| Plan | The itemised, human-readable result of resolving a blueprint with a set of answers: up to 18 areas, each a list of labelled items, plus notices. Preview and apply resolve the same plan. Producing a plan writes nothing. |
| Area (group) | The unit the review screen shows and the unit you can turn off. Two areas are required and cannot be turned off: business hours and queues, because service levels, routing rules and category defaults reference them. |
| Notice | An advisory line on the review screen. Notices never block apply. |
| Plan-gated area | An area whose rows are created regardless of tier but whose management screens your plan does not include (service levels, business hours, project templates). The review screen names the gate and the tier that lifts it. |
| Apply result | One line per area: rows created, rows already in place, whether it was skipped, and an error message if the area failed. Areas run one at a time; a failed area does not roll back the others. |
| Setup state | The only thing the interview persists: the last blueprint applied, when, the answers given, rows created per area (accumulated), the last 20 applies, and the client-defaults profile if opted in. |
| Client defaults | The stored profile applied to every client the MSP creates afterwards: business hours and holidays, queues, one SLA tier, and ticket categories. Country, coverage and time zone come from the interview. |
| Getting Started checklist | The persistent hub. MSP: 40 steps in 6 groups (Company foundation, Your team, Service desk, Clients, Billing & finance, Operations & growth). Organization: 34 steps in 6 groups (Workspace foundation, Your team, Service desk & knowledge, Billing & subscription, Power features, Operations), plus a 4-step “Onboard this client” group only the servicing MSP sees. |
| Detector | A read-only check that decides whether a step is done, run on every load. 59 exist. A step with a detector is an auto step and cannot be ticked by hand. |
| Manual step | A step with no detector. MSP: Review roles & permissions, Remove Solidlio branding, Explore roll-up reporting. Organization: Review roles & permissions, Set your support & escalation preferences, Review invoice & billing settings, Explore roll-up reporting. |
| Step status | complete, incomplete, skipped, locked (plan does not include it) or managed (provider-owned, on a managed client). Precedence: managed, then locked, then skipped, then complete, then incomplete. |
| Progress | applicable = total − locked − skipped − managed; percent = round(100 × completed / applicable), or 100 when nothing applies. |
| Dismissal | Hides the Getting Started navigation entry, its percentage badge and the dashboard card, and stops nudges. The hub itself stays reachable at its URL and offers Restore it. |
| Nudge | An email naming the workspace’s first incomplete step. Per workspace, never per user: at most 3, at least 3 days apart. |
| Activation snapshot | One row per workspace per day recording percent, counts, tier and every step’s status, feeding the platform Activation Funnel. |
| Tour | A data-defined list of steps, each pointing at an element on a page by a data-tour attribute. Three ship, all on organization pages. A tour runs when a page is opened with ?tour=<id>. |
| First-login wizard | The MSP welcome flow at /msp/onboarding. An MSP admin is redirected into it until its “onboarding completed” flag is set. Its “Your Setup” step embeds the blueprint interview. |
The web app renders the wizard (BusinessSetupWizard), the hub (GettingStartedHub) and the tour overlay (components/tours).
Roles and permissions
The role hierarchy is platform administrator > MSP administrator > MSP technician > organization administrator > power user > CUSTOMER`. MSP technician outranks organization administrator. Every floor below is “this role or higher”.
| Action | Minimum role | Extra requirement |
|---|---|---|
| Land in the first-login wizard | MSP administrator | Redirected automatically while the account’s onboarding flag is unset |
| List blueprints, preview, apply, read setup status | MSP administrator | Apply also needs the account to have an organization |
| Read, tick, skip, dismiss or restore the MSP checklist | MSP administrator | MSP technician receives 403 |
| Read, tick, skip the organization checklist (own organization) | organization administrator | power user and CUSTOMER are rejected |
Read or update a client’s checklist (?organizationId=) | MSP technician in practice (organization administrator floor) | The caller’s account must service that client; otherwise 404 |
| Complete a provider-owned step on a managed client | MSP technician, viewing the client | The client’s own admins receive 403 on those three steps |
| Dismiss or restore the organization checklist | organization administrator | Own organization only; ?organizationId= is ignored here |
| Run a tour | Anyone who can open the page | Show me is offered on the organization hub only |
| Trigger a nudge or snapshot run | Internal service key | Not a user action; called by the scheduler |
| View the Activation Funnel | platform administrator | Platform portal, /platform/activation |
Tenant scope is not a role check. The blueprint provisions the MSP’s own organization (its earliest-created one); client organizations are separate accounts and are only touched through client defaults. A client checklist is resolved against the client’s tier and managed status, whoever is viewing.
Walkthroughs
First login as a new MSP admin
- After signup and the plan interstitial, the first MSP admin to sign in is sent to
/msp/onboarding. The sidebar keeps sending you back there until the wizard is completed. - Welcome lists the steps. Company Profile captures business email, phone, website and the legal address (this is also the sender identity’s address). Your Plan shows the plan chosen at signup, read-only, with an in-place upgrade. Billing & Tax captures payment terms, accepted payment methods and sales tax, and can be skipped (“Skip for now — I’ll set this up later”).
- Your Setup embeds the blueprint interview described next. Its finish button is Finish. Below it, Skip this — I will set things up myself moves on without provisioning anything.
- Complete sets the onboarding flag and hands you to
/msp/getting-started.
Set up your business from a blueprint
MSP portal: Settings → Set up my business (/msp/settings/business-setup), or the Set up your business in one go step at the top of Getting Started.
- Pick. Six cards. Select one and press Continue, or open a card’s detail view to read who it is for, what you get, its interview defaults, and the full plan it would produce from those defaults (item counts per area). If you have applied a blueprint before, the pick screen says which and when, and reminds you that applying another only adds what is missing.
- Interview. Every answer is pre-filled for the blueprint. The questions, their options and what each changes are in Configuration below. Choosing Canada sets CAD, choosing the United States sets USD; you can override the currency to EUR. Two switches close the interview: copy the agreement pack, and apply this standard to new clients.
- Review. “Here is exactly what we will set up” lists every item, grouped by area, with a running count of items and areas. Skip this turns an optional area off (Add back restores it); business hours and queues have no switch. Notices appear above the list. An area whose management screen your plan does not include is flagged with the capability name and the tier that carries it.
- Apply. Progress copy tells you it is safe to leave: a later run picks up where this one stopped. A full Managed apply is roughly 800 rows and takes a few seconds.
- Done. “We created N things for you. M were already there and were left alone.” Each area shows N created, already in place, or Could not be set up — try again. If any area failed, a notice says running setup again will finish it. The finish button opens Getting Started (or returns to Settings when launched from there).
Layer a second blueprint later
Open Settings → Set up my business again, pick the new blueprint and run the interview. Everything that already exists under the same name is left alone and counted as already in place; only the new blueprint’s additional queues, categories, templates, runbooks and services are created. The setup status records the newest blueprint as current and appends the run to its history.
Work the Getting Started checklist
MSP portal: Getting Started (/msp/getting-started). Organization portal: Getting Started (/org/getting-started). The navigation entry carries the current percentage; the dashboard shows a card with the next steps and a View all link.
- The page opens on a progress ring and one chip per group. Clicking a chip scrolls to that group and expands its first incomplete step.
- Expand any step to read why it matters, what you’ll need and the time estimate.
- Set it up opens the page that does the work. When you come back the step has ticked itself if the detector sees the result.
- Show me appears on steps with a tour, in the organization portal only.
- Mark done appears on manual steps; Undo reverses it. Skip removes a step from your denominator; a skipped step shows Undo too.
- A locked step shows “Upgrade required” or the tier name and price, and an Upgrade button that opens the in-place upgrade when the account can self-serve.
- A managed step (organization portal, managed clients only) shows “Handled by your provider” and no actions.
- At 100% a banner offers Dismiss. Dismissing hides the navigation entry, badge and dashboard card and stops nudges. The hub page then shows “This checklist is dismissed from your navigation” with Restore it.
Take a tour
- On the organization hub, expand Invite your team, Create your ticket queues or Connect your support email and press Show me.
- You land on the target page with
?tour=<id>appended. The rest of the screen dims, the control to click is outlined, and a popover explains it with Back, Next and Done. Esc or ✕ ends the tour; ← and → move between steps. - If the target has not rendered yet the runner polls for it for about five seconds, then shows the popover in the centre of the screen. Finishing or closing the tour removes
?tour=from the address.
Review a client’s checklist as its provider
Open Clients → client → Onboarding. Below the tracker the client’s own Getting Started checklist is shown with the Onboard this client group only you can see, and the three provider-owned steps become actionable.
Configuration
The interview
| Question | Options | What it changes |
|---|---|---|
| How big is your team? | Just me · 2–5 people · 6–15 people · 16+ people | Caps queues at 4 / 7 / 9 / 11 and teams at 0 / 2 / 4 / 6, taken from the front of the blueprint’s list. References to a dropped queue fall back to the default queue. |
| What hours do you cover? | Business hours (Mon–Fri 08:00–17:00) · Extended (Mon–Fri 07:00–19:00) · Extended + emergency on-call (same calendar, 24/7 for P1) · 24/7 (every day 00:00–23:59) | Writes the seven business-hours rows and caps the SLA ladder: business hours → Bronze only; extended and on-call → up to Silver; 24/7 → up to Gold. The highest tier the coverage supports becomes the default policy. |
| How do you bill? | Per user · Per device · Flat monthly fee · By the hour · Prepaid blocks of hours · Fixed-price projects (multi-select) | Every answer adds something you can bill against. By the hour creates the four-level labour rate card; Prepaid blocks creates the block-hour packages; Per user, Per device, Flat monthly fee and Fixed-price projects each add the catalogue lines that model is sold on. If a line could not be added, the review screen says which model it was for. |
| What do you look after? | Help desk · Workstations & devices · Networks, firewalls & Wi-Fi · Servers & infrastructure · Microsoft 365 & cloud · Security · Backup & DR · Phones & VoIP · Projects & migrations · Compliance & governance (multi-select) | Each area adds its service SKUs to the catalogue selection; the blueprint’s own SKUs are always included; duplicates are removed. |
| Standard hourly rate | $1 to $10,000 per hour | Anchors the rate card (Junior 0.6×, Technician 1.0×, Senior 1.4×, Principal 2.0×; cost rate is 60% of bill rate) and the block prices. |
| Where are you? | Country: Canada, United States · Time zone: 12 North American zones · Currency: CAD, USD, EUR | Country picks the statutory holiday calendar (CA or US, two years) and moves the currency. Time zone is the zone every SLA clock evaluates in. Currency converts catalogue prices from CAD and, when a rate exists, becomes the account’s operating currency. |
| Copy the agreement pack | on / off | Copies the blueprint’s starter agreements (MSA, NDA, SOW, SLA, AUP, DPA as applicable) into your account. |
| Apply to new clients | on / off | Stores the client-defaults profile; every client created afterwards receives hours, queues, SLA tier and categories. |
Blueprint defaults: solo — Just me, business hours, hourly + blocks, $125; managed — 6–15, extended + on-call, per user + per device + hourly + projects, $150; co-managed — 2–5, extended, hourly + blocks + projects + flat, $175; security — 6–15, 24/7, per user + per device + flat + projects, $185; vcio — Just me, business hours, flat + projects + hourly, $250, apply to new clients off; blank — 2–5, business hours, hourly, $150, agreements and new-client defaults off. Every blueprint defaults to Canada, CAD and America/Toronto.
What each blueprint selects
Counts are before the team-size cap is applied.
| Blueprint | Queues | Teams | SLA tiers | Category groups | Automations | Runbooks & policies | Project templates | Block packages | Agreements |
|---|---|---|---|---|---|---|---|---|---|
solo | 4 | 0 | Bronze | 8 | 4 | 8 | 0 | 10, 20, 40 h | 6 |
managed | 11 | 6 | Bronze, Silver | 15 | 12 | 18 | 7 | 10, 20, 40 h | 6 |
co-managed | 9 | 4 | Bronze, Silver | 9 | 8 | 10 | 5 | 20, 40 h | 5 (no AUP) |
security | 11 | 6 | Bronze, Silver, Gold | 13 | 12 | 18 | 5 | 20, 40 h | 6 |
vcio | 4 | 2 | Bronze | 5 | 4 | 7 | 7 | 20, 40 h | 4 (MSA, NDA, SOW, DPA) |
blank | 1 | 0 | none | 0 | 0 | 0 | 0 | none | none |
The shared catalogue behind them: 11 queues (Triage, Service Desk, Escalations, Field Dispatch, Projects, Alerts / NOC, Security, Onboarding & Offboarding, Procurement, Change Requests, Billing & Account Management), 6 teams, 15 three-level category groups, 27 canned responses, 14 request templates, 12 automations, 18 runbooks and policies, 7 project templates, and default status workflows per ticket type. Canned responses and request templates vary per blueprint and are listed in the review screen.
Service-level tiers
Minutes are business minutes unless the row is 24/7.
| Tier | P1 respond / resolve | P2 | P3 | P4 | P4 backlog | Around the clock |
|---|---|---|---|---|---|---|
| Bronze — Business Hours | 60 m / 8 h | 4 h / 16 h | 8 h / 24 h | 16 h / 80 h | 32 h / 160 h | none |
| Silver — Standard Managed | 30 m / 4 h | 2 h / 8 h | 4 h / 16 h | 8 h / 40 h | 16 h / 80 h | P1 only |
| Gold — 24/7 Critical | 15 m / 4 h | 30 m / 8 h | 2 h / 8 h | 4 h / 24 h | 8 h / 48 h | P1 and P2 |
Rates, packages and pricing
- Rate card: Junior 0.6×, Technician 1.0×, Senior 1.4×, Principal 2.0× of your hourly rate, rounded to whole dollars; cost rate 60% of bill rate; written against every service the run activates.
- Block packages: 10 h at 10% off (valid 90 days), 20 h at 12% off (90 days), 40 h at 15% off (180 days); priced from the Technician rate, whole dollars; a 15% platform fee is recorded on each.
- Catalogue prices: the platform’s benchmark price per SKU, converted from CAD to your currency using the platform’s rate table, rounded to whole dollars, and never below the platform cost price.
- Hardware pricing profile: Standard, 1.0× multiplier, 3% FX buffer, round up to .99. Created only if the account has none.
- Operating currency: the account’s default currency is switched to your answer only when the catalogue was actually converted. With no usable rate, prices stay in CAD, the account is left alone, and the review screen says so.
What gets written, and how a re-run behaves
| Area | Matched on | On re-run when it already exists |
|---|---|---|
| Business hours | organization + day of week | Updated to the current answers (times, enabled, time zone) |
| Holidays | organization + date | Left alone |
| Queues | organization + name | Re-activated if inactive; every other setting left alone |
| Routing rules | queue + rule name | Left alone |
| Teams | organization + name | Left alone |
| SLA policies | organization + name | Left alone; missing priority targets are added |
| Categories | organization + path | Left alone (written level by level so children find their parents) |
| Status workflows | organization + ticket type + default | Left alone; missing transitions are added |
| Canned responses | organization + name | Left alone |
| Request templates | organization + name | Left alone |
| Automations | organization + name | Left alone, except a queue placeholder from an older install is repaired |
| Service catalogue | account + platform service | Left alone |
| Labour rate card | account service + skill level | Left alone |
| Block-hour packages | account + name | Left alone |
| Hardware pricing profile | one per account | Left alone |
| Agreement templates | account + category + name | Left alone |
| Runbooks & policies | organization + title | Left alone; published for staff only (MSP-internal) |
| Project templates | organization + name | Left alone; duration in days = hours ÷ 8, rounded up |
Creating a new default SLA policy clears the default flag on any existing policy in the organization; a policy that already exists is not touched.
Client defaults
Stored when “Apply to new clients” is on. Applied in the background when a client is created from the client wizard and when clients are bulk-imported from QuickBooks Online. The client receives, in its own organization: business hours for the stored coverage, one year of holidays for the stored country, the stored queues, the stored SLA tier as its default policy, and the stored category groups. Fourteen areas are excluded by an explicit list: currency, teams, status workflows, canned responses, request templates, automations, service catalogue, rate card, block packages, pricing profile, agreements, runbooks and project templates. A failure is logged and does not fail client creation.
Installation prerequisites
| Prerequisite | If absent |
|---|---|
| Starter agreement templates published by a platform admin | The Agreement templates area is dropped from the plan and a notice says the templates “have not been published on this installation yet” |
| Platform service catalogue seeded | The Service catalog area is dropped and a notice says the catalogue “has not been published on this installation yet” |
| An exchange rate for USD or EUR in the platform rate table | Prices stay in CAD, the account currency is not changed, and a notice says so |
| The MSP account has an organization | Apply is refused with “This account has no organization yet. Finish company setup first.” |
Checklist state, nudges and snapshots
| Setting | Where | Effect |
|---|---|---|
| Manual ticks and skips | Per step, in the hub | Stored with a timestamp; everything else is recomputed on each load |
| Dismissal | Hub banner at 100%, or the dashboard card | Hides the navigation entry, badge and card; excludes the workspace from nudges |
| Email notifications | Each person’s notification preferences | A recipient who has turned email off is never nudged (opted_out) |
Nudge recipients: the organization’s primary active organization administrator, or for an MSP account the primary active MSP administrator in the MSP’s own organization. An MSP’s own organization is excluded from the organization scan so it is nudged about the checklist its portal actually shows. Each run scans up to 500 subjects per scope.
Plan tiers
Guided setup carries no plan gate. The interview, both checklists, tours, nudges and snapshots are available on every tier, including Free, and a blueprint creates its full set on every tier.
Three areas the blueprint creates have management screens that are gated. The review screen flags them before you apply, with the tier that lifts the gate and the in-place upgrade:
| Area | Requires | MSP tier | End-customer tier |
|---|---|---|---|
| Service levels | slaManagement at BASIC or above | Starter and above | Professional and above |
| Business hours & holidays | slaManagement at ADVANCED | Growth and above | Business and above |
| Project templates | projectManagement | Starter and above | Professional and above |
Individual checklist steps lock the same way. A locked step shows the tier, its monthly price and, where the account can self-serve, an Upgrade button; ticking a locked step through the API returns the same upgrade envelope.
| Checklist step | Requires | MSP tier | End-customer tier |
|---|---|---|---|
| Define SLA policies | slaManagement at BASIC or above | Starter | Professional |
| Create a project | projectManagement | Starter | Professional |
| Connect your support email | emailIntegration at BASIC or above | Growth | Professional |
| Route email into a queue | emailIntegration at BASIC or above | Growth | Professional |
| Connect QuickBooks Online (MSP only) | quickbooks in integrations | Growth | — |
| Set up change management | changeManagement at BASIC or above | Growth | Professional |
| Create an API key | apiAccess at READ_ONLY or above | Growth | Professional |
| Use a custom portal domain | customDomains | Scale | Business |
| Explore roll-up reporting | rollUpReporting at BASIC or above | Scale | Business |
| Set your brand colors | customBranding at FULL | Enterprise | Enterprise |
| Remove Solidlio branding (MSP only) | whiteLabel | Enterprise | — |
| Enable single sign-on | ssoEnabled | Enterprise | Enterprise |
MSP tiers: Free, Starter, Growth, Scale, Enterprise. End-customer tiers: Free, Essentials, Professional, Business, Enterprise. Locked steps never count against your percentage.
Limits and known behaviour
- The interview is an MSP feature. A directly-subscribed organization has no blueprint interview; it has the checklist, tours and nudges.
- Business hours are the one area that is overwritten. Re-running with a different coverage answer rewrites the seven day rows. Every other area only adds.
- Names are the match key. Rename a provisioned queue, policy or template and a re-run creates a fresh one under the catalogue name. A queue you deactivated is re-activated by a re-run.
- Team size trims from the end of the blueprint’s list. The Security blueprint keeps its Security board inside the cap; routing rules, category defaults and request templates that pointed at a dropped queue fall back to the default queue or to no queue.
- Coverage caps the ladder. A 24/7 blueprint answered “business hours” ships Bronze only, and a notice says the 24/7 tier was left out.
- Plan gates never block creation. Service levels, business hours and project templates are created on Free; only their management screens are gated.
- Countries and holidays. The interview offers Canada and the United States. Any other two-letter code accepted by the API produces zero holidays rather than a guessed calendar.
- Currency. CAD, USD and EUR in the interview. Without a usable rate the catalogue stays in CAD and the account currency is not changed.
- Client defaults run in the background after the client is created, so a client tenant is never held open behind a few hundred configuration rows. Profiles stored before the country field existed apply the Canadian calendar.
- “Set up your business in one go” completes only when the interview has been applied, even if you built the same rows by hand.
- Some steps are personal. MFA and notification-preference steps reflect the signed-in person; a different admin may see a different status.
- Some MSP detectors look across managed clients. Contracts, assets, software, networks, purchasing, monitoring, change requests and projects count in the MSP’s own organization or any client it manages.
- Dismissal hides the sidebar entry, not the page. After dismissing, the hub stays reachable from Settings → Getting started in both portals, and by its URL (
/msp/getting-started,/org/getting-started). - Tours. Three exist, all for organization pages; the MSP hub never shows Show me. Progress is not remembered; a tour does not advance on its own when you click the highlighted control.
- Nudges are opt-in and bounded. Off unless the scheduler is configured for them; one recipient per workspace; 500 subjects per scope per run.
- Not available on mobile.
Troubleshooting
| Message or symptom | Where | Cause | What to do |
|---|---|---|---|
These parts of setup cannot be skipped: business-hours, queues | Apply | A required area was in exclude | Remove it; service levels and routing depend on those rows |
This account has no organization yet. Finish company setup first. | Apply | The MSP account has no organization of its own | Complete the company step of the first-login wizard, then apply |
| “The starter agreement templates have not been published on this installation yet…” | Review notice | No platform starter templates exist | A platform admin publishes them; re-run and the Agreement templates area reappears |
| “The platform service catalog has not been published on this installation yet…” | Review notice | The platform service catalogue has not been seeded | Seed the reference catalogue; re-run |
| “We could not get an exchange rate for USD just now, so the catalog prices below are in CAD…” | Review notice | No fresh CAD→USD (or EUR) rate in the platform table | Apply anyway and correct prices under Services, or wait for the daily rate refresh and re-run |
| “You told us you cover business hours only, so we left out the 24/7 service level…” | Review notice | Coverage answer capped the ladder below the blueprint’s top tier | Expected; add Gold later once on-call cover exists |
| “This blueprint does not ship block-hour packages…” | Review notice | Prepaid blocks selected on a blueprint with no packages | Create packages under Services after setup |
| “No service catalog lines matched your answers…” | Review notice | No service areas selected and the blueprint has no SKUs of its own | Tick at least one area |
| “Could not be set up — try again” on an area; “Some parts did not go through.” | Done screen | That area’s writes failed; the rest succeeded | Run setup again; completed areas report “already in place” |
| “We could not load the setup options.” | Wizard | The blueprints request failed | Retry; check the caller is an MSP admin |
This checklist item requires a plan upgrade. (403, with upgrade) | PATCH a locked step | The account’s tier does not include the step’s feature | Upgrade via the envelope’s tier, or leave it locked (it does not count against you) |
This item is completed automatically and cannot be marked done manually | PATCH done on an auto step | The step has a detector | Do the underlying task; the step ticks itself |
This item is managed by your provider. (403) | PATCH on a managed client | A client admin tried to change a provider-owned step | The servicing MSP completes it from Clients → Onboarding |
Checklist item not found | PATCH | Unknown step key | Use a key from the GET payload |
Organization not found (404) when passing ?organizationId= | Organization checklist | The caller’s account does not service that organization | Only a servicing MSP or platform admin can target another organization |
Organization ID required | Organization checklist | No organization context on the request | Sign in to an organization portal |
Provide done and/or skipped | PATCH | Empty body | Send at least one of the two |
| A step stays incomplete after doing the work | Hub | The detector looks at a specific record (for example an active mailbox with a default queue) | Check the item’s “why” text for what counts; reload the hub |
| Getting Started missing from the sidebar | Portal | The checklist was dismissed, or the signed-in role is not an admin for that portal | Open the hub URL and press Restore it |
| Tour popover appears in the centre pointing at nothing | Tour | The target element is not on the page (wrong page, or data still loading past the poll window) | Open the tour from the checklist’s Show me so it lands on the right page |
Nudge run reports skipped with opted_out, capped, too_soon, dismissed, complete, no_recipient, no_next_step or send_failed | Run summary | Each reason names the guard that stopped the email | Expected; send_failed retries on the next run without advancing the cadence |