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

HTTPRequired

Responses

200

Successful response

application/json

get/api/v2/ticket

GET /api/v2/ticket HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

index

post

Creates a new empty ticket.

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

Authorizations

HTTPRequired

Body

brandIDstringOptional

type: number

channelIDstringOptional

type: number

directionstringOptional

type: ^inbound|outbound$

fromstringOptional

type: string

fromNamestringOptional

type: string = ' '

tostringOptional

type: string

titlestringOptional

type: string

assignedGroupIDstringOptional

type: number = 0

formIDstringOptional

type: number = null

Responses

200

Successful response

application/json

post/api/v2/ticket

POST /api/v2/ticket HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 156

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

200

Successful response

item

get

Returns all the data of this ticket.

Authorizations

HTTPRequired

Path parameters

ticketIDstringRequired

Responses

200

Successful response

application/json

get/api/v2/ticket/{ticketID}

GET /api/v2/ticket/{ticketID} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

item

put

Updates the fields of this ticket.

Authorizations

HTTPRequired

Path parameters

ticketIDstringRequired

Body

externalPrimaryIDstringOptional

type: string = null

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

titlestringOptional

type: string = null

statusstringOptional

type: ^(solved|closed)$ = null

Responses

200

Successful response

application/json

put/api/v2/ticket/{ticketID}

PUT /api/v2/ticket/{ticketID} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 59

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

200

Successful response

item

delete

Deletes all the data of this ticket.

Authorizations

HTTPRequired

Path parameters

ticketIDstringRequired

Responses

200

Successful response

application/json

delete/api/v2/ticket/{ticketID}

DELETE /api/v2/ticket/{ticketID} HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

multi

delete

Deletes multiple tickets given in an array.

Authorizations

HTTPRequired

Responses

200

Successful response

application/json

delete/api/v2/ticket/multi

DELETE /api/v2/ticket/multi HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

setStatus

post

Sets the status of the tickets given in an array.

Authorizations

HTTPRequired

Body

statusstringOptional

type: ^(new|open|pending|holding|solved|closed)$

ticketIDs[]stringOptional

type: number

Responses

200

Successful response

application/json

post/api/v2/ticket/setStatus

POST /api/v2/ticket/setStatus HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 38

{
  "status": "text",
  "ticketIDs[]": "text"
}

200

Successful response

setPriority

post

Sets the priority of the tickets given in an array.

Authorizations

HTTPRequired

Body

prioritystringOptional

type: ^(low|medium|high|urgent)$

ticketIDs[]stringOptional

type: number

Responses

200

Successful response

application/json

post/api/v2/ticket/setPriority

POST /api/v2/ticket/setPriority HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 40

{
  "priority": "text",
  "ticketIDs[]": "text"
}

200

Successful response

unlinkCustomerFromTicket

post

Unlinks the customer from the ticket provided.

Authorizations

HTTPRequired

Body

ticketIDstringOptional

type: number

Responses

200

Successful response

application/json

post/api/v2/ticket/unlinkCustomerFromTicket

POST /api/v2/ticket/unlinkCustomerFromTicket HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 19

{
  "ticketID": "text"
}

200

Successful response

batch

post

Performs miscellaneous actions on tickets given in an array.

Authorizations

HTTPRequired

Body

TicketIDsstringOptional

type: ^[0-9, ]+$

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

actions[0][actionType]stringOptional

type: string

Needs to be an action type.

actions[0][value]stringOptional

type: string

Needs to be the value the action would use.

Responses

200

Successful response

application/json

post/api/v2/ticket/batch

POST /api/v2/ticket/batch HTTP/1.1
Host: {{base_url}}
Authorization: apikey YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 79

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

200

Successful response