Skip to content

Function: removeRequestParticipants() ​

ts
function removeRequestParticipants(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Defined in: src/serviceDesk/api/request.ts:598

This method removes participants from a customer request.

Permissions required: Permission to manage participants on the customer request.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ accountIds?: string[]; issueIdOrKey: string; usernames?: string[]; }-
parameters.accountIds?string[]List of users, specified by account IDs, to add to or remove as participants in the request.
parameters.issueIdOrKey?stringThe ID or key of the customer request to have participants removed.
parameters.usernames?string[]This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use accountIds instead.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }>