ATatlassian
Request

Create customer request

Changed on

This method creates a customer request in a service desk.

The JSON request must include the service desk and customer request type, as well as any fields that are required for the request type. A list of the fields required by a customer request type can be obtained using servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field.

The fields required for a customer request type depend on the user's permissions:

  • raiseOnBehalfOf is not available to Users who have the customer permission only.
  • requestParticipants is not available to Users who have the customer permission only or if the feature is turned off for customers.

requestFieldValues is a map of Jira field IDs and their values. See Field input formats, for details of each field's JSON semantics and the values they can take.

Permissions required: Permission to create requests in the specified service desk.

post/rest/servicedeskapi/request

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/servicedeskapi/request
  • Auth
    OAuth 2
    Authorization code: https://auth.atlassian.com/authorize
    Token URL: https://auth.atlassian.com/oauth/token scopes: write:servicedesk-request

Request body

channelstring

(Experimental) Shows extra information for the request channel.

isAdfRequestboolean

(Experimental) Whether to accept rich text fields in Atlassian Document Format (ADF).

raiseOnBehalfOfstring

The accountId of the customer that the request is being raised on behalf of.

requestFieldValuesobject

JSON map of Jira field IDs and their values representing the content of the request.

requestParticipantsstring[]

List of customers to participate in the request, as a list of accountId values.

requestTypeIdstring

ID of the request type for the request.

serviceDeskIdstring

ID of the service desk in which to create the request.

Response

Returned if the customer request was created.

_expandsstring[]

List of items that can be expanded in the response by specifying the expand query parameter.

issueIdstring

ID of the request, as the peer issue ID.

issueKeystring

Key of the request, as the peer issue key.

requestTypeIdstring

ID of the request type for the request.

serviceDeskIdstring

ID of the service desk the request belongs to.

summarystring

Summary of the request created

Changes

  • bba7b3477d98Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

  • 7c79c3ffe305Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property