Function createCustomer

createCustomer(
    client: Client,
    parameters: {
        displayName?: string;
        email?: string;
        fullName?: string;
        strictConflictStatusCode?: boolean;
    },
    options?: RequestOptions,
): Promise<
    {
        _links?: {
            avatarUrls?: Record<string, any>;
            jiraRest?: string;
            self?: string;
            [key: string]: unknown;
        };
        accountId?: string;
        active?: boolean;
        displayName?: string;
        emailAddress?: string;
        key?: string;
        name?: string;
        timeZone?: string;
        [key: string]: unknown;
    },
>
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
- client: Client
- parameters: {
      displayName?: string;
      email?: string;
      fullName?: string;
      strictConflictStatusCode?: boolean;
  }
  - OptionaldisplayName?: string
    
    Customer's name for display in the UI.
  - Optionalemail?: string
    
    Customer's email address.
  - OptionalfullName?: string
    
    Deprecated, please use 'displayName'.
  - OptionalstrictConflictStatusCode?: boolean
    
    Optional boolean flag to return 409 Conflict status code for duplicate customer creation request
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _links?: {
            avatarUrls?: Record<string, any>;
            jiraRest?: string;
            self?: string;
            [key: string]: unknown;
        };
        accountId?: string;
        active?: boolean;
        displayName?: string;
        emailAddress?: string;
        key?: string;
        name?: string;
        timeZone?: string;
        [key: string]: unknown;
    },
>
- Defined in src/serviceDesk/api/customer.ts:15

Function createCustomer

Parameters

`Optional`displayName?: string

`Optional`email?: string

`Optional`fullName?: string

`Optional`strictConflictStatusCode?: boolean

Settings

Function createCustomer

Parameters

OptionaldisplayName?: string

Optionalemail?: string

OptionalfullName?: string

OptionalstrictConflictStatusCode?: boolean

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

Settings

`Optional`displayName?: string

`Optional`email?: string

`Optional`fullName?: string

`Optional`strictConflictStatusCode?: boolean

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