Update Project Description

Updates project description.

A project is the top-level container for everything in Norbix — environments, modules, and data. These endpoints create and configure projects. This method updates the project description — only the fields you send are changed.

This method is on the Hub surface (norbix.hub.account) — call it from admin tooling or IaC.

These examples assume the SDK is installed and your credentials are set as environment variables — each client reads them automatically, so the constructors below take no arguments. See Install a Norbix SDK.

JavaScript / TypeScript

import { Norbix } from '@norbix.ai/ts';
const norbix = new Norbix();

const result = await norbix.hub.account.updateProjectDescription({
  description: 'Managed via the Norbix SDK.',
});

.NET

using Norbix.Sdk;
using Norbix.Sdk.Types.Hub;

using var client = new NorbixClient();

var result = await client.Account.UpdateProjectDescriptionAsync(new UpdateProjectDescription
{
    Description = "Managed via the Norbix SDK.",
});

Python

from norbix_python import NorbixHub

norbix = NorbixHub()

result = norbix.account.update_project_description(
    description="Managed via the Norbix SDK.",
)

Go

c, _ := norbix.New(norbix.Options{})
ctx := context.Background()

var result map[string]any
err := c.Hub.Account.UpdateProjectDescription(ctx, map[string]any{
	"description": "Managed via the Norbix SDK.",
}, &result)

Swift

import NorbixSwift

let client = Norbix()

let result = try await client.hub.account.updateProjectDescription([
    "description": "Managed via the Norbix SDK.",
])

Kotlin

import dev.norbix.sdk.hub.NorbixHub

val hub = NorbixHub()

val result = hub.account.updateProjectDescription(mapOf(
    "description" to "Managed via the Norbix SDK.",
))

CLI

norbix hub account project description update --description 'Managed via the Norbix SDK.'

Dart / Flutter examples for this page are still in the works — we are verifying the exact SDK shapes and will add them shortly. The method itself is available in every Norbix SDK.

In the dashboard

Manage this visually in Norbix Cloud — see Account & Projects → Projects.

API reference

Full request and response for this endpoint: Update Project Description.