PermuteDocs
Go to Permute

Apps · appsUpdate

Update app settings

Saves app settings with a compare-and-set draft ref. Optional login settings customize the side panel image, header, subheader, title, subtitle and primary/secondary hex colors for both access methods. Images use verified app uploads (PNG, JPEG or WebP, up to 2 MiB). Set login to null to restore the default appearance. Optional chat.enabled controls the platform assistant overlay (defaults to true for signed-in apps); password demos receive no assistant. Publish separately to apply settings; access policies and sessions are unchanged.

PATCH/v1/apps/{applicationId}
betaapiKeyworkspace

When to use

Change the app name, description, favicon or login appearance.

For agents

Read the latest draft ref first. A stale ref returns a conflict. Upload login images through apps.uploadFiles (PNG, JPEG or WebP, up to 2 MiB), then reference the returned descriptor in login.sidePanelImage. Upload a PNG favicon up to 256 KiB the same way and set favicon to its descriptor. Publish the saved draft to apply appearance; login: null restores default login styling, and favicon: null removes the icon override.

Example

typescript
import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const client = orgClient.withWorkspace(process.env.PERMUTE_WORKSPACE_ID!);

const result = await client.apps.update('appl_abcdefghijklmnopqrstuvwx', {
  "name": "Operations portal",
  "description": "Internal operations portal",
  "expectedDraft": {
    "revisionId": "rvsn_draft123",
    "sequence": 1
  }
});

Request body

json
{
  "name": "Operations portal",
  "description": "Internal operations portal",
  "expectedDraft": {
    "revisionId": "rvsn_draft123",
    "sequence": 1
  }
}

Response

json
{
  "data": {
    "id": "appl_abcdefghijklmnopqrstuvwx",
    "workspaceId": "wksp_finance123",
    "name": "Operations portal",
    "description": "Internal operations portal",
    "deployment": {
      "status": "deploying",
      "url": "https://operations-portal-abcdefghijklmnopqrstuvwx.permute.site",
      "revisionId": "rvsn_draft123",
      "error": null
    },
    "draft": {
      "revisionId": "rvsn_draft456",
      "sequence": 2
    },
    "createdAt": "2026-09-30T12:00:00.000Z",
    "updatedAt": "2026-09-30T12:00:00.000Z"
  }
}