• Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Request Type Permissions
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / Reference / REST API

Customer

Postman Collection
OpenAPI
POST

Create customer

Creates a customer that is not associated with a service project.

The customer's username is their email address. They can set a password by clicking "Forgotten your password" onthe portal login screen, or a Jira administrator can set one in User Management. By default, the customer canemail requests to public service projects. If they have a password, they can also raise requests in customer portals that allowpublic signup. To raise requests in closed service projects, the customer must be added to a service projectusing Add customers.

This operation does not cause invitation email to be sent to the newly created customer.

Jira administrator global permission is required to create a customer.

Request

Request bodyapplication/json

The customer to create.

email

string

fullName

string

Responses

Return the newly created customer.

application/json

UserDTO
POST/servicedeskapi/customer
1 2 3 4 5 6 7 8 curl --request POST \ --url 'http://{baseurl}/rest/servicedeskapi/customer' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "email": "<string>", "fullName": "<string>" }'
201Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "name": "<string>", "key": "<string>", "emailAddress": "<string>", "displayName": "<string>", "active": true, "timeZone": "<string>", "_links": { "jiraRest": "<string>", "avatarUrls": {}, "self": "<string>" } }

Rate this page: