Skip to content

Function: renameScreenTab() ​

ts
function renameScreenTab(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  id?: number;
  name: string;
}>;

Defined in: src/cloud/api/screenTabs.ts:69

Updates the name of a screen tab.

Permissions required:Administer Jira global permission.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ id?: number; name: string; screenId: number; tabId: number; }-
parameters.id?numberThe ID of the screen tab.
parameters.name?stringThe name of the screen tab. The maximum length is 255 characters.
parameters.screenId?numberThe ID of the screen.
parameters.tabId?numberThe ID of the screen tab.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; id?: number; name: string; }>