Remove customer from ServiceDesk

Eduardo_phy8ae

Hi, i'm developing a external solution using Jira Service Desk Cloud API and i need to bring the posibility of remove customer totally from JSD (I have configured the project with closed access). If i do it manually on the JSD portal, it's all OK, but if i do it using the JSD Cloud API seems don't do nothing but don't return any Api error, 204 OK Code returned. 

Can you give any help to achieve that funcionality?

 

Thank you very much.

Earl McCutcheon

Hello @Eduardo , 

Thanks for reaching out and first off I just wanted to make a referance point for anyone else looking for a similar answer but are on the Server Platform that runs int this thread as this one is currently only avaliable in Jira Cloud,  If you are on Jira Server the Feature is being tracked here:

• https://jira.atlassian.com/browse/JSDSERVER-5933

Next, it sound like you already have this info but as an additional referance point to do this via the API the endpoint you are looking for is going to be:

• DELETE /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer 

However, an additional Note is that the Endpoint is currently an Experimental endpoint so you will need to add in a "X-ExperimentalApi: opt-in" header and the endpoint can change without notice, so do be aware of this if you are planning to use this in production.  As an Example the formatting should look like the following using a CURL using either "accountIds" or "usernames" as described in the Documentation above in the Example i used "accountIds" as Both the "accountIds" and the "userNames" options  will take the same account ID as human readable usernames no longer work due to changes implemented for GDPR security to obfuscate usernames as plain text.  :

curl -D- -u EMAIL:API_TOKEN -X DELETE \
 --header 'Content-Type: application/json' \
 --header 'X-ExperimentalApi: opt-in' \
 --URL 'https://{yourdomain}.atlassian.net/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer' \
 --data '{
  "accountIds": [
    "{Insert_Account-ID:here}"
  ]
}'

As noted in the Documentation the 204 OK will be returned if successful OR if the user listed is not in the particular Service desk, and no action is taken if this is the case:

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.

 So I would suggest double-checking the account id's that you are inputing and you can do so via the Get customers API endpoint, noting that this one is currently Experimental as well and requires the additional header noted above:

• GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer

And one caveat to this one that may be the issue you are encountering is that the accountID value that is returned in this GET, currently will return any colon character ":" with the "%3A" encoding but it needs to be converted back to a ":" for use in the DELETE call.

Please check this out and let me know what you find.

Regards,
Earl