Skip to content

Function: addRequestParticipants() ​

ts
function addRequestParticipants(
   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;
  maxResultWindow?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Defined in: src/serviceDeskServer/api/customerRequests.ts:233

Adds users as participants to an existing customer request.

Note, you can also add participants when creating a request via the request resource, by using the requestParticipants field.

Permissions:

The calling user must have permission to manage participants for this customer request.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ issueIdOrKey: string; limit?: number; start?: number; usernames?: string[]; }-
parameters.issueIdOrKeystringThe id or key of the customer request.
parameters.limit?numberThe maximum number of items to return per page. Default: 50.
parameters.start?numberThe starting index of the returned objects. Base index: 0.
parameters.usernames?string[]-
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; maxResultWindow?: number; size?: number; start?: number; values?: object[]; }>