Skip to content

Function: addCustomers() ​

ts
function addCustomers(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/serviceDesk/api/servicedesk.ts:132

Adds one or more customers to a service desk. If any of the passed customers are associated with the service desk, no changes will be made for those customers and the resource returns a 204 success code.

Permissions required: Service desk administrator

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ accountIds?: string[]; serviceDeskId: string; usernames?: string[]; }-
parameters.accountIds?string[]List of users, specified by account IDs, to add to or remove from a service desk.
parameters.serviceDeskId?stringThe ID of the service desk the customer list should be returned from. This can alternatively be a project identifier.
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<void>