Swagger: Update Portal Product
swagger_update_portal_productModify product settings in a portal to change its display name, URL slug, description, and visibility. Control how the product appears and who can access it.
Instructions
Update a product's settings within a specific portal.
Toolset: Products
Parameters:
productId (string) required: Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product
name (string): Update product display name - changes how it appears to users in navigation and listings (3-40 characters)
slug (string): Update URL-friendly identifier - must remain unique within the portal, affects product URLs (3-22 characters, lowercase, alphanumeric with hyphens/underscores/dots)
description (string): Update product description - explains the API/product functionality, shown in listings (max 110 characters)
public (boolean): Change product visibility - true makes it publicly accessible to all visitors, false restricts to authenticated users with roles
visibility (enum): Change whether the product is shown on the portal landing page - 'visible' shows it to everyone, 'hidden' hides it from everyone, 'conditional' shows it only to users who have access to the product. Not allowed when the product is public; making a 'conditional' product public without also changing visibility fails with 409
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Update product display name - changes how it appears to users in navigation and listings (3-40 characters) | |
| slug | No | Update URL-friendly identifier - must remain unique within the portal, affects product URLs (3-22 characters, lowercase, alphanumeric with hyphens/underscores/dots) | |
| public | No | Change product visibility - true makes it publicly accessible to all visitors, false restricts to authenticated users with roles | |
| productId | Yes | Product UUID or identifier in the format 'portal-subdomain:product-slug' - unique identifier for the product | |
| visibility | No | Change whether the product is shown on the portal landing page - 'visible' shows it to everyone, 'hidden' hides it from everyone, 'conditional' shows it only to users who have access to the product. Not allowed when the product is public; making a 'conditional' product public without also changing visibility fails with 409 | |
| description | No | Update product description - explains the API/product functionality, shown in listings (max 110 characters) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| url | No | ||
| name | No | ||
| slug | No | ||
| public | No | ||
| portalId | No | ||
| visibility | No | ||
| description | No |