jira.js
    Preparing search index...

    Function partialUpdateProjectRole

    • Updates either the project role's name or its description.

      You cannot update both the name and description at the same time using this operation. If you send a request with a name and a description only the name is updated.

      Permissions required: Administer Jira global permission.

      Parameters

      • client: Client
      • parameters: { description?: string; id: number; name?: string }
        • Optionaldescription?: string

          A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.

        • id: number

          The ID of the project role. Use Get all project roles to get a list of project role IDs.

        • Optionalname?: string

          The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              actors?: {
                  actorGroup?: {
                      displayName?: string;
                      groupId?: string;
                      name?: string;
                      [key: string]: unknown;
                  };
                  actorUser?: { accountId?: string; [key: string]: unknown };
                  avatarUrl?: string;
                  displayName?: string;
                  id?: number;
                  type?:
                      | string & {}
                      | "atlassian-group-role-actor"
                      | "atlassian-user-role-actor";
                  [key: string]: unknown;
              }[];
              admin?: boolean;
              currentUserRole?: boolean;
              default?: boolean;
              description?: string;
              id?: number;
              name?: string;
              roleConfigurable?: boolean;
              scope?: {
                  project?: {
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      id?: string;
                      key?: string;
                      name?: string;
                      projectCategory?: {
                          description?: string;
                          id?: string;
                          name?: string;
                          self?: string;
                          [key: string]: unknown;
                      };
                      projectTypeKey?: | string & {}
                      | "software"
                      | "service_desk"
                      | "business"
                      | "product_discovery"
                      | "customer_service";
                      self?: string;
                      simplified?: boolean;
                      [key: string]: unknown;
                  };
                  type?: string & {}
                  | "PROJECT"
                  | "TEMPLATE";
                  [key: string]: unknown;
              };
              self?: string;
              translatedName?: string;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility