Function: createCustomer()

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

Defined in: src/serviceDesk/api/customer.ts:15

This method adds a customer to the Jira Service Management instance by passing a JSON file including an email address and display name. The display name does not need to be unique. The record's identifiers, name and key, are automatically generated from the request details.

Permissions required: Jira Administrator Global permission

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ displayName?: string; email?: string; fullName?: string; strictConflictStatusCode?: boolean; }	-
parameters.displayName?	string	Customer's name for display in the UI.
parameters.email?	string	Customer's email address.
parameters.fullName?	string	Deprecated, please use 'displayName'.
parameters.strictConflictStatusCode?	boolean	Optional boolean flag to return 409 Conflict status code for duplicate customer creation request
options?	RequestOptions	-

Returns

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