Products
Product marketing and menu
Set a product's presentation: the Product Overview marketing page, its Menu Items, and the Features Table that compares plans side by side. Features Table changes save as you make them.
A product carries its own presentation in the dashboard across three tabs: Product Overview is its marketing page, Menu Items is its in-portal navigation, and Features Table compares its plans. Product Overview and Menu Items are saved with Save Changes in the product header. Features Table changes are saved as you make them.
What is the Product Overview tab?
Product Overview is the product's marketing page, built from sections. You add sections, fill them in, toggle each one Active, and a preview pane shows how the page renders in your API Portal.
The tab lists a set of predefined sections you can add and reorder:
| Section | Use it for |
|---|---|
| Product Features | The main reasons to use the product, each with a title, description and image. |
| Product Workflows | Step-by-step cards showing how to get started or complete key tasks. |
| Product Statistics | A row of cards with key numbers or achievements. |
| Product Usage | Use cases that show how the product fits real scenarios. |
| Product Callouts | Highlighted blocks for key messages, each with a title, description and button. |
Each section has an Active / Inactive toggle that controls whether it shows on the page, and most sections hold records you add, edit, reorder, and delete. The right pane previews the section you have open. Page Preview switches it to the whole page.
How do I build the Product Overview page?
Add a section, turn it Active, add its records, and check the preview. Then save the product.
- Open the product and select the Product Overview tab.
- Open a section such as Product Features or Product Callouts and choose its add button, for example + Add features section.
- Toggle the section Active so it appears on the page.
- Choose Add another record to add records, then edit their fields.
- Use Page Preview to see the whole page, then choose Save Changes in the product header.
Sections are reorderable with their drag handles, so the order you set is the order developers see. An empty page shows a placeholder in the preview until you add a section.
What are Menu Items?
Menu Items set the per-product navigation shown in your API Portal. You add, reorder, and remove entries, except for the protected ones that every product keeps.
The protected entries are details, plans, documentation, and changelog. They cannot be removed from the product menu. The changelog entry is available only when changelog is enabled for your account. Without it, the entry is disabled and says your plan does not support changelog.
Use this tab to add links to the product's in-portal navigation alongside the protected entries, then choose Save Changes in the product header.
What is the Features Table?
The Features Table is a comparison grid with the product's features as rows and its plans as columns. For each feature you tick which plans include it, and you can give a feature a per-plan value. Every change saves as you make it.
The grid needs a plan, because it compares plans. Each column shows a plan's name, and where a plan has more than one version a dropdown chooses which version the column shows. Edit and Page Preview switch between editing the grid and previewing it.
- Open the product and select the Features Table tab.
- Choose + Create Features for the first feature, or Add another Feature after that. The new feature is named New Feature and starts ticked on the product's first plan.
- Rename the feature and give it a description.
- For each plan column, tick the feature to include it in that plan.
- Optionally type a per-plan value for the feature, for example a quota.
- Reorder features by dragging, and use Page Preview to check the result.
A feature must stay on at least one plan, so you cannot untick it from the last plan that has it. Delete the feature instead. There is no Save Changes step and no undo, so each rename, tick, value, reorder or delete takes effect straight away.
The comparison table is what developers use to tell the product's plans apart, for example a free tier next to a paid tier.
Troubleshooting
| What you see | What to do |
|---|---|
| Adding a feature is disabled, and hovering it says Create a plan first to add a feature | The product has no plan. Create one on the API Plans tab, then add features. |
| A banner says your product hasn't been created yet | Save the new product first, then add features on the Features Table tab. |
| Adding a feature is disabled, and hovering it says you do not have permission | Your role cannot create products. Ask an administrator for a role that manages products. |
| A feature's tick cannot be cleared on a plan | It is the only plan with that feature. Tick it on another plan first, or delete the feature. |
| A marketing section does not appear in the preview | The section is set to Inactive. Toggle it Active to show it on the page. |
| There is no option to add a custom marketing section | Custom sections need to be enabled for your account. Use the predefined sections instead. |
| The changelog entry in Menu Items is disabled | Changelog is not enabled for your account. The other protected entries stay available. |
| A protected menu entry cannot be removed | The details, plans, documentation, and changelog entries are protected and stay in every product menu. |
Where to next
Create and publish a product
Create a product, set its Details, add a plan, and publish it.
Product categories
Create categories and group products in your API Portal catalog.
Anatomy of a plan
The plan tabs, the plan lifecycle, and when to create a new version.
Assign scopes to a plan
Set each scope to Active, Optional, or Restricted on a plan.