Skip to content

Function: addCustomers() ​

ts
function addCustomers(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     avatarUrls?: Record<string, any>;
     jiraRest?: string;
     self?: string;
  };
  active?: boolean;
  displayName?: string;
  emailAddress?: string;
  key?: string;
  name?: string;
  timeZone?: string;
}>;

Defined in: src/serviceDeskServer/api/customers.ts:47

Adds one or more existing customers to the given service project. If you need to create a customer, see Create customer.

Administer project permission is required, or agents if public signups and invites are enabled for the service project.)

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ serviceDeskId: string; usernames?: string[]; }-
parameters.serviceDeskIdstringThe ID of the service project.
parameters.usernames?string[]-
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; _links?: { [key: string]: unknown; avatarUrls?: Record<string, any>; jiraRest?: string; self?: string; }; active?: boolean; displayName?: string; emailAddress?: string; key?: string; name?: string; timeZone?: string; }>