Sign in

v3

latestOpenAPI 3.0.12026-08-0474115357.9 KB
Customer

Create customer

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

post/rest/servicedeskapi/customer

Query parameters

strictConflictStatusCodeboolean

Optional boolean flag to return 409 Conflict status code for duplicate customer creation request

Request body

displayNamestring

Customer's name for display in the UI.

emailstring

Customer's email address.

fullNamestring

Deprecated, please use 'displayName'.

Response

Returns the customer details.

accountIdstring

The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

activeboolean

Indicates if the customer is active (true) or inactive (false)

displayNamestring

Customer's name for display in a UI. Depending on the customer’s privacy settings, this may return an alternative value.

emailAddressstring

Customer's email address. Depending on the customer’s privacy settings, this may be returned as null.

keystring

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

namestring

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

timeZonestring

Customer time zone. Depending on the customer’s privacy settings, this may be returned as null.