Skip to main content

UpdateAppArgs

type UpdateAppArgs = {
  appTokenScopes?:   | readonly (
     | Permission
     | string & {
   })[]
     | null;
  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.

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.