renameSite
Client function: rename a site (display name in the manifest + dashboard metadata).
import { renameSite } from 'flowstack-sdk'Non-React client function. Updates a built app's display name. PATCH /api/v1/sites/{siteId} with { name }.
Signature
renameSite(credentials, siteId, name, config?): Promise<ApiResponse<{ site_id: string; name: string }>>Parameters
| Param | Type | Notes | Description |
|---|---|---|---|
credentials | FlowstackCredentials | required | The app owner's credentials (owner-scoped JWT). |
siteId | string | required | The site/app id to operate on. |
name | string | required | The new display name. |
config | FlowstackClientConfig | since 0.2.7 | Client config (baseUrl, appScope, tenantId as needed). |
Returns
| Field | Type | Description |
|---|---|---|
| — | Promise<ApiResponse<{ site_id: string; name: string }>> | { ok, data: { site_id, name }, error }. |
Examples
Rename a site
const res = await renameSite(credentials, siteId, 'My CRM', { appScope });
if (!res.ok) console.error(res.error);WarningOwner/management operation — call it with the app owner's credentials from a builder/dashboard/server context, not from inside the generated app's end-user runtime.
builtAppSafe is false.See also
getAppSource · useSiteVersions
Source: src/api/client.ts (Site Ops, P0-156) · Also available in llms-full.txt and registry.json.