Create Improvement Request

POST

improvement-requests

curl --request POST \
  --url https://public.api.serval.com/v2/improvement-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "ticketId": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/improvement-requests"

payload = {
    "teamId": "<string>",
    "ticketId": "<string>",
    "description": "<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({teamId: '<string>', ticketId: '<string>', description: '<string>'})
};

fetch('https://public.api.serval.com/v2/improvement-requests', 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/improvement-requests",
  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([
    'teamId' => '<string>',
    'ticketId' => '<string>',
    'description' => '<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/improvement-requests"

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"ticketId\": \"<string>\",\n  \"description\": \"<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/improvement-requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"ticketId\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/improvement-requests")

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  \"teamId\": \"<string>\",\n  \"ticketId\": \"<string>\",\n  \"description\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "ticketId": "<string>",
    "messageId": "<string>",
    "description": "<string>",
    "status": "IMPROVEMENT_REQUEST_STATUS_UNSPECIFIED",
    "suggestionSessionId": "<string>",
    "requestedByUserId": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "declineReason": "<string>",
    "acceptedChanges": [
      {
        "kind": "<string>",
        "id": "<string>",
        "name": "<string>",
        "externalUrl": "<string>"
      }
    ]
  }
}

Authentication and permissions

Token requirements: User-based token (OAuth). 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	Unsupported
Team-scoped API key	Unsupported
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. Only a signed-in user can file an improvement request; API keys are refused.

New ticket: Without ticket_id, opens a ticket on team_id that holds the request, with you as its requester.
Attach to a team ticket: With ticket_id, the ticket must be visible to you.
Attach to your own ticket: With ticket_id, you must be the ticket’s requester. Not available for system-created tickets or tickets restricted to their team.

Authorizations

Authorization

string

header

required

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

Body

application/json

teamId

string | null

The ID of the team to ask. Required unless ticket_id is set; a new ticket is opened on this team.

ticketId

string | null

Optional. The ID of an existing ticket to attach the request to. When omitted, a new ticket is opened on team_id to hold the request.

description

string

What should improve: the recurring need, and what a good outcome looks like. It becomes the body of the message the request is attached to.

Response

200 - application/json

Success

data

data · object

A requester's ask for the team to improve how a kind of request is handled: a workflow, a Help Desk Skill, a knowledge change, or a mix. It is attached to the ticket message it was filed in, whose body is its description.

Show child attributes

Create Improvement Request

curl --request POST \
  --url https://public.api.serval.com/v2/improvement-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "ticketId": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/improvement-requests"

payload = {
    "teamId": "<string>",
    "ticketId": "<string>",
    "description": "<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({teamId: '<string>', ticketId: '<string>', description: '<string>'})
};

fetch('https://public.api.serval.com/v2/improvement-requests', 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/improvement-requests",
  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([
    'teamId' => '<string>',
    'ticketId' => '<string>',
    'description' => '<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/improvement-requests"

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"ticketId\": \"<string>\",\n  \"description\": \"<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/improvement-requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"ticketId\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/improvement-requests")

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  \"teamId\": \"<string>\",\n  \"ticketId\": \"<string>\",\n  \"description\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "ticketId": "<string>",
    "messageId": "<string>",
    "description": "<string>",
    "status": "IMPROVEMENT_REQUEST_STATUS_UNSPECIFIED",
    "suggestionSessionId": "<string>",
    "requestedByUserId": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "declineReason": "<string>",
    "acceptedChanges": [
      {
        "kind": "<string>",
        "id": "<string>",
        "name": "<string>",
        "externalUrl": "<string>"
      }
    ]
  }
}

Get started

Authentication

Endpoints

Development

Authentication and permissions

Authorizations

Body

Response

​Authentication and permissions

Authorizations

Body

Response

Authentication and permissions