Ticket API

Submit Ticket Feedback

Submit a user’s feedback (CSAT) on a ticket. Defaults to the ticket’s requester; pass user_id to submit for another user. Answers the ticket’s pending feedback request for that user when one exists, otherwise records new feedback. The response variant (thumbs or detailed) must match the team’s configured feedback question format. Submitting again after the user has already answered replaces their rating; an omitted text_feedback keeps the existing comment.

POST

tickets

{ticket_id}

feedback

Submit Ticket Feedback

curl --request POST \
  --url https://public.api.serval.com/v2/tickets/{ticket_id}/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "detailed": {
    "starRating": 123,
    "textFeedback": "<string>"
  },
  "userId": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/tickets/{ticket_id}/feedback"

payload = {
    "detailed": {
        "starRating": 123,
        "textFeedback": "<string>"
    },
    "userId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({detailed: {starRating: 123, textFeedback: '<string>'}, userId: '<string>'})
};

fetch('https://public.api.serval.com/v2/tickets/{ticket_id}/feedback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public.api.serval.com/v2/tickets/{ticket_id}/feedback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'detailed' => [
        'starRating' => 123,
        'textFeedback' => '<string>'
    ],
    'userId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/tickets/{ticket_id}/feedback"

	payload := strings.NewReader("{\n  \"detailed\": {\n    \"starRating\": 123,\n    \"textFeedback\": \"<string>\"\n  },\n  \"userId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/tickets/{ticket_id}/feedback")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"detailed\": {\n    \"starRating\": 123,\n    \"textFeedback\": \"<string>\"\n  },\n  \"userId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/tickets/{ticket_id}/feedback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"detailed\": {\n    \"starRating\": 123,\n    \"textFeedback\": \"<string>\"\n  },\n  \"userId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "detailed": {
      "starRating": 123,
      "textFeedback": "<string>"
    },
    "id": "<string>",
    "ticketId": "<string>",
    "targetUserId": "<string>",
    "feedbackSubjectType": "FEEDBACK_SUBJECT_TYPE_UNSPECIFIED",
    "feedbackAboutUserId": "<string>",
    "requestedAt": "2025-01-15T01:30:15.000Z",
    "respondedAt": "2025-01-15T01:30:15.000Z",
    "attachments": [
      {
        "id": "<string>",
        "name": "<string>",
        "contentType": "<string>",
        "url": "<string>",
        "isInline": true,
        "contentId": "<string>",
        "description": "<string>"
      }
    ]
  }
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	`tickets:write`
Team-scoped API key	`tickets:write`
User-based token (OAuth)	Supported, subject to permissions

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

ticket_id

string

required

The ID of the ticket the feedback is about.

Body

application/json

SubmitTicketFeedbackRequest
SubmitTicketFeedbackRequest

detailed

detailed · object

required

Show child attributes

userId

string | null

The user giving the feedback. Defaults to the ticket's requester. If the ticket has a pending feedback request for this user it is answered; if the user already answered, the latest submission replaces their rating (an omitted text_feedback keeps the existing comment); otherwise a feedback record is created and answered in one step.

Response

200 - application/json

Success

data

data · object

data
data

Show child attributes

Submit Ticket Feedback

curl --request POST \
  --url https://public.api.serval.com/v2/tickets/{ticket_id}/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "detailed": {
    "starRating": 123,
    "textFeedback": "<string>"
  },
  "userId": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/tickets/{ticket_id}/feedback"

payload = {
    "detailed": {
        "starRating": 123,
        "textFeedback": "<string>"
    },
    "userId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({detailed: {starRating: 123, textFeedback: '<string>'}, userId: '<string>'})
};

fetch('https://public.api.serval.com/v2/tickets/{ticket_id}/feedback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public.api.serval.com/v2/tickets/{ticket_id}/feedback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'detailed' => [
        'starRating' => 123,
        'textFeedback' => '<string>'
    ],
    'userId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/tickets/{ticket_id}/feedback"

	payload := strings.NewReader("{\n  \"detailed\": {\n    \"starRating\": 123,\n    \"textFeedback\": \"<string>\"\n  },\n  \"userId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/tickets/{ticket_id}/feedback")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"detailed\": {\n    \"starRating\": 123,\n    \"textFeedback\": \"<string>\"\n  },\n  \"userId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/tickets/{ticket_id}/feedback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"detailed\": {\n    \"starRating\": 123,\n    \"textFeedback\": \"<string>\"\n  },\n  \"userId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "detailed": {
      "starRating": 123,
      "textFeedback": "<string>"
    },
    "id": "<string>",
    "ticketId": "<string>",
    "targetUserId": "<string>",
    "feedbackSubjectType": "FEEDBACK_SUBJECT_TYPE_UNSPECIFIED",
    "feedbackAboutUserId": "<string>",
    "requestedAt": "2025-01-15T01:30:15.000Z",
    "respondedAt": "2025-01-15T01:30:15.000Z",
    "attachments": [
      {
        "id": "<string>",
        "name": "<string>",
        "contentType": "<string>",
        "url": "<string>",
        "isInline": true,
        "contentId": "<string>",
        "description": "<string>"
      }
    ]
  }
}

​Authentication and permissions

Authorizations

Path Parameters

Body

Response

Authentication and permissions