Update app settings – PATCH /v1/apps/{applicationId}

PATCH/v1/apps/{applicationId}

betaapiKeyworkspace

When to use

Change the app name or description.

For agents

Read the latest draft ref first. A stale ref returns a conflict.

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"
  }
}