Ticket

All the endpoints that can be called on the Ticket controller.

Endpoints that require the TICKET_READ permission:

GET index
GET item

Endpoints that require the TICKET_CREATE permission:

POST index

Endpoints that require the TICKET_UPDATE permission:

PUT item
POST setPriority

Endpoints that require the TICKET_DELETE permission:

DELETE item
DELETE multi

Endpoints that require the SET_STATUS permission:

POST setStatus
PUT solveUnfinishedTickets

Endpoints that require the TICKET_BATCH permission:

POST batch

index

get

Returns all tickets with optional filters such as search queries, views and result limits.

Authorizations

apiKeystringRequired

Query parameters

applyViewstring · min: 2Optional

The view to get the tickets from.

Default: ""Pattern: ^[0-9a-zA-Z\-\_]+$

querystring · min: 1OptionalDefault: ""

itemStartnumberOptionalDefault: 0

itemLimitnumber · max: 9999OptionalDefault: 15

searchArchivedstring · enumOptionalDefault: noPossible values:

statusstring · enumOptionalPossible values:

Responses

200Success

No content

get

/api/v2/ticket

GET /api/v2/ticket HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content

index

post

Creates a new empty ticket.

Data can be added directly, but also through other /ticket endpoints.

Authorizations

apiKeystringRequired

Body

brandIDnumberRequired

channelIDnumberRequired

directionstring · enumRequiredPossible values:

fromstring · min: 2Required

fromNamestring · min: 1OptionalDefault: ""

tostring · min: 2Required

titlestring · min: 2Required

assignedGroupIDnumberOptionalDefault: 0

formIDnumberOptional

Responses

200Success

No content

post

/api/v2/ticket

POST /api/v2/ticket HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 135

{
  "brandID": 1,
  "channelID": 1,
  "direction": "inbound",
  "from": "text",
  "fromName": "",
  "to": "text",
  "title": "text",
  "assignedGroupID": 0,
  "formID": 1
}

200Success

No content

item

get

Returns all the data of this ticket.

Authorizations

apiKeystringRequired

Path parameters

ticketIDnumberRequired

Query parameters

reloadbooleanOptional

Checks if the ticket is already open. If not, register that it has been opened.

Default: false

getTicketHistorybooleanOptional

Send along this parameter with a value to get the ticket history.

Default: false

Responses

200Success

No content

get

/api/v2/ticket/{ticketID}

GET /api/v2/ticket/{ticketID} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content

item

put

Updates the fields of this ticket.

Authorizations

apiKeystringRequired

Path parameters

ticketIDnumberRequired

Body

externalPrimaryIDstringOptional

The external primary ID of the customer this ticket belongs to.

titlestringOptional

statusstring · enumOptionalPossible values:

Responses

200Success

No content

put

/api/v2/ticket/{ticketID}

PUT /api/v2/ticket/{ticketID} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 57

"externalPrimaryID='text'&title=''&status='solved'"

200Success

No content

item

delete

Deletes all the data of this ticket.

Authorizations

apiKeystringRequired

Path parameters

ticketIDnumberRequired

Responses

200Success

No content

delete

/api/v2/ticket/{ticketID}

DELETE /api/v2/ticket/{ticketID} HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Accept: */*

200Success

No content

multi

delete

Deletes multiple tickets given in an array.

Authorizations

apiKeystringRequired

Body

ticketIDsnumber[]Required

Responses

200Success

No content

delete

/api/v2/ticket/multi

DELETE /api/v2/ticket/multi HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "ticketIDs": [
    1
  ]
}

200Success

No content

setStatus

post

Sets the status of the tickets given in an array.

Authorizations

apiKeystringRequired

Body

statusstring · enumRequiredPossible values:

ticketIDsnumber[]Required

Responses

200Success

No content

post

/api/v2/ticket/setStatus

POST /api/v2/ticket/setStatus HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 32

{
  "status": "new",
  "ticketIDs": [
    1
  ]
}

200Success

No content

setPriority

post

Sets the priority of the tickets given in an array.

Authorizations

apiKeystringRequired

Body

prioritystring · enumRequiredPossible values:

ticketIDsnumber[]Required

Responses

200Success

No content

post

/api/v2/ticket/setPriority

POST /api/v2/ticket/setPriority HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 34

{
  "priority": "low",
  "ticketIDs": [
    1
  ]
}

200Success

No content

unlinkCustomerFromTicket

post

Unlinks the customer from the ticket provided.

Authorizations

apiKeystringRequired

Body

ticketIDnumberRequired

Responses

200Success

No content

post

/api/v2/ticket/unlinkCustomerFromTicket

POST /api/v2/ticket/unlinkCustomerFromTicket HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 14

{
  "ticketID": 1
}

200Success

No content

batch

post

Performs miscellaneous actions on tickets given in an array.

Authorizations

apiKeystringRequired

Body

TicketIDsstringOptional

Can be multiple ID's comma-separated (space allowed).

Pattern: ^[0-9, ]+$

Responses

200Success

No content

post

/api/v2/ticket/batch

POST /api/v2/ticket/batch HTTP/1.1
Host: {{base_url}}
apiKey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 69

{
  "TicketIDs": "text",
  "actions": [
    {
      "actionType": "text",
      "value": "text"
    }
  ]
}

200Success

No content

PreviousStatisticsv2 NextUser

Last updated 4 months ago