Skip to main content

UpdateAppArgs

type UpdateAppArgs = {
  appTokenScopes?:   | readonly (
     | Permission
     | string & {
   })[]
     | null;
  clientType?: AppClientType;
  description?: string;
  displayName?: string;
  oauthRedirectUri?: string | null;
  serviceUrl?: string;
};

Arguments for updating a developer application. All fields are optional — only provided fields are updated.

Pass appTokenScopes as an array (e.g. ['data:read', 'task:add']); the SDK serializes it to the comma-separated string the backend expects.

Properties​

appTokenScopes?​

optional appTokenScopes: 
  | readonly (
  | Permission
  | string & {
})[]
  | null;

Updated list of scopes the app may request. Pass null to clear.

Typed as Permission | (string & {}) so known scopes get autocomplete while still permitting plain strings — needed so a fetched App['appTokenScopes'] (typed string[] | null) can be passed back to updateApp() without casts.

clientType?​

optional clientType: AppClientType;

Updated OAuth client type. Set to 'public' for apps that cannot keep a secret (native apps, browser extensions, CLIs), so they exchange authorization codes with PKCE alone. The client secret is kept, so switching back to 'confidential' needs no new one.

Dynamically registered clients cannot change it: the API rejects the update with BAD_REQUEST.

description?​

optional description: string;

Updated app description.

displayName?​

optional displayName: string;

Updated display name.

oauthRedirectUri?​

optional oauthRedirectUri: string | null;

Updated OAuth redirect URI. Pass null to clear.

serviceUrl?​

optional serviceUrl: string;

Updated service URL.