How to add custom fields on Jira Service Desk request Api

[satheesh]

I need to pass custom fields through the create request api. How to do that?

POST /rest/servicedeskapi/request

$data = [
    "serviceDeskId" => $serviceDeskId,
    "requestTypeId" => $request->feedback_type,
    "requestParticipants" => [
        $customerId
    ],
    "requestFieldValues" => [
        "summary" => $request->summary,
        "description" => $request->description,
     ],
];

[Ewin Davis K · Accepted solution]

Hi @satheesh , this document describes how you can pass custom field value in the rest API's. https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/#fieldformats

Let me know if that helps.

[Ewin Davis K]

You will need to know the custom field Id after which you can pass it in the requestFieldValues. e.g. 

{
  "requestParticipants": [
    "5ee0a49c775ca80ac014b29f"
  ],
  "serviceDeskId": "13",
  "requestTypeId": "309",
  "requestFieldValues": {
    "summary": "Request JSD help via REST",
    "description": "I need a new *mouse* for my Mac",
    "customfield_10086": "Testing custom field"
  }
}

[satheesh]

Thanks for the response. I tried it and it says "Unable to create request because of theses errors : The field 'customfield_10036' i"s not valid".

[satheesh]

Thanks Ewin. I have changed the fields to be visible. Now it's working fine.

[Bhanu Chava]

@satheesh I am facing the same issue , Can you please point out the way to change the fields to visible . Where should I change it ? Thank you 

[Richard Jenkins]

@Bhanu Chava , the field needs to be visible in the Request Type in the Service Desk. If you want to use the api for Service Desk, then the actual portal must be set up, even if you have it hidden from portal, the actual request type must be configured with the fields

[amir abu issa]

Hi,

can anyone send example how to add field in jsm request?

Thanks