PUT /resources/v1/ticket/{businessNumber}/create-ticket

Servers

Path parameters

Name Type Required Description
businessNumber Number Yes

Business number of the location on which we want to create a ticket.

Request headers

Name Type Required Description
api_key String No

e.g. abcdefgh (string, required) - Partner specific API key provided by Birdeye for data exchange.

Accept String No

e.g. application/json

Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
surveyResponseId Number No

Id of the survey response for which we want to create a ticket. Applicable for survey ticket

customer Object No

Customer details for which ticket is created, Mandatory and applicable for untagged ticket

customer.emailId String No

Email id of the customer.

customer.location Object No

Location details of the customer.

customer.location.state String No

State of the customer’s location.

customer.location.city String No

City of the customer’s location.

customer.lastName String No

Last name of the customer.

customer.phone Number No

Phone number of the customer.

customer.firstName String No

First name of the customer.

externalId Number No

Public Review Id for which you want to create ticket, Mandatory and applicable for creating review ticket.

description String No

Description of the ticket. Applicable for untagged and survey ticket

ticketType String Yes

Type of ticket you want to create. Possible values:

                                review,
                                untagged,
                                SURVEY
assignedTo String Yes

EmailId of the user to whom the ticket will be assigned.

sourceType String No

Source Type of the ticket. Applicable for untagged ticket Possible values:

                        Email,
                        Phone,
                        Chat,
                        Internal,
                        Social media
additionalParams[] Array No

If you want to create tickets of survey for particular question and answer. Applicable for survey ticket

surveyId Number No

Id of the survey for which we want to create a ticket. Applicable for survey ticket

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.