Hi,
Can we add a customer in an existing Jira Service Desk Project via a Rest API call?
Hi @Stakater SRE _ 1 and welcome to the community,
I have not done it myself but I'm pretty sure you can.
This entry in the api documentation explains as such
Create Customer
POST /rest/servicedeskapi/customer
This method adds a customer to the Jira Service Desk 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.
name
key
It would atleast allow you to create the customer as step 1
If the customer then exists a 2nd call to add the customer to the SD would be:
Add Customer to JSD Project
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
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.
We can create customers with the Create Customers api call which you mentioned but can we delete them too? Or if we want to verify that the customer already exists, is there a relevant Get api call. Can't find the support of this in the api docs.
Actually the link below add customers
Delete Customers
DELETE /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
This method removes one or more customers from a service desk. The service desk must have closed access. If any of the passed customers are not associated with the service desk, no changes will be made for those customers and the resource returns a 204 success code.
Permissions required: Services desk administrator
As for "getting" it seems you can not search for a specific customer but you can get a list of all customers added to the project.
Get Customers
There you could parse the list to see if the user you need is in there.
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer
This method returns a list of the customers on a service desk.
The returned list of customers can be filtered using the query parameter. The parameter is matched against customers' displayName, name, or email. For example, searching for "John", "Jo", "Smi", or "Smith" will match a user with display name "John Smith".
query
displayName
email
Permissions required: Permission to view this Service Desk's customers.
All the other actions are availble on: https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-group-servicedesk
I think you misunderstood the question :-)
Creating customers and adding customers to the projects are two separate things. As you mentioned in your first answer that in order to add customer to the project, we have to make two api calls. First to create the customer and than to add the created customer to the project. Similarly the api provides support to remove that customer from the project as well. Buy my question is that can we completely delete the created customers?
The below scenario may help you understand the problem.
For example: We create a customer, we add him into two projects. Now, the api provides us the support to remove the customer from either project. But can we completely delete that customer so that it get simultaneously removed from both projects? I don't find the api support for that.
It looks like you're new here. Sign in or register to get started.
