Update Ticket - Serval Documentation

PUT

tickets

{id}

Update Ticket

curl --request PUT \
  --url https://public.api.serval.com/v2/tickets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "statusId": "<string>",
  "priorityId": "<string>",
  "assignedToUserId": "<string>",
  "labelIds": [
    "<string>"
  ],
  "slaStartedAt": "2025-01-15T01:30:15.000Z",
  "slaBreachesAt": "2025-01-15T01:30:15.000Z",
  "requesterUserId": "<string>",
  "dueDate": {
    "year": 123,
    "month": 123,
    "day": 123
  },
  "waitUntil": "2025-01-15T01:30:15.000Z",
  "nameTranslations": {},
  "descriptionTranslations": {},
  "categoryOptionId": "<string>",
  "assignedToGroupId": "<string>"
}
'

import requests

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

payload = {
    "name": "<string>",
    "description": "<string>",
    "statusId": "<string>",
    "priorityId": "<string>",
    "assignedToUserId": "<string>",
    "labelIds": ["<string>"],
    "slaStartedAt": "2025-01-15T01:30:15.000Z",
    "slaBreachesAt": "2025-01-15T01:30:15.000Z",
    "requesterUserId": "<string>",
    "dueDate": {
        "year": 123,
        "month": 123,
        "day": 123
    },
    "waitUntil": "2025-01-15T01:30:15.000Z",
    "nameTranslations": {},
    "descriptionTranslations": {},
    "categoryOptionId": "<string>",
    "assignedToGroupId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    statusId: '<string>',
    priorityId: '<string>',
    assignedToUserId: '<string>',
    labelIds: ['<string>'],
    slaStartedAt: '2025-01-15T01:30:15.000Z',
    slaBreachesAt: '2025-01-15T01:30:15.000Z',
    requesterUserId: '<string>',
    dueDate: {year: 123, month: 123, day: 123},
    waitUntil: '2025-01-15T01:30:15.000Z',
    nameTranslations: {},
    descriptionTranslations: {},
    categoryOptionId: '<string>',
    assignedToGroupId: '<string>'
  })
};

fetch('https://public.api.serval.com/v2/tickets/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'statusId' => '<string>',
    'priorityId' => '<string>',
    'assignedToUserId' => '<string>',
    'labelIds' => [
        '<string>'
    ],
    'slaStartedAt' => '2025-01-15T01:30:15.000Z',
    'slaBreachesAt' => '2025-01-15T01:30:15.000Z',
    'requesterUserId' => '<string>',
    'dueDate' => [
        'year' => 123,
        'month' => 123,
        'day' => 123
    ],
    'waitUntil' => '2025-01-15T01:30:15.000Z',
    'nameTranslations' => [
        
    ],
    'descriptionTranslations' => [
        
    ],
    'categoryOptionId' => '<string>',
    'assignedToGroupId' => '<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/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"statusId\": \"<string>\",\n  \"priorityId\": \"<string>\",\n  \"assignedToUserId\": \"<string>\",\n  \"labelIds\": [\n    \"<string>\"\n  ],\n  \"slaStartedAt\": \"2025-01-15T01:30:15.000Z\",\n  \"slaBreachesAt\": \"2025-01-15T01:30:15.000Z\",\n  \"requesterUserId\": \"<string>\",\n  \"dueDate\": {\n    \"year\": 123,\n    \"month\": 123,\n    \"day\": 123\n  },\n  \"waitUntil\": \"2025-01-15T01:30:15.000Z\",\n  \"nameTranslations\": {},\n  \"descriptionTranslations\": {},\n  \"categoryOptionId\": \"<string>\",\n  \"assignedToGroupId\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://public.api.serval.com/v2/tickets/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"statusId\": \"<string>\",\n  \"priorityId\": \"<string>\",\n  \"assignedToUserId\": \"<string>\",\n  \"labelIds\": [\n    \"<string>\"\n  ],\n  \"slaStartedAt\": \"2025-01-15T01:30:15.000Z\",\n  \"slaBreachesAt\": \"2025-01-15T01:30:15.000Z\",\n  \"requesterUserId\": \"<string>\",\n  \"dueDate\": {\n    \"year\": 123,\n    \"month\": 123,\n    \"day\": 123\n  },\n  \"waitUntil\": \"2025-01-15T01:30:15.000Z\",\n  \"nameTranslations\": {},\n  \"descriptionTranslations\": {},\n  \"categoryOptionId\": \"<string>\",\n  \"assignedToGroupId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"statusId\": \"<string>\",\n  \"priorityId\": \"<string>\",\n  \"assignedToUserId\": \"<string>\",\n  \"labelIds\": [\n    \"<string>\"\n  ],\n  \"slaStartedAt\": \"2025-01-15T01:30:15.000Z\",\n  \"slaBreachesAt\": \"2025-01-15T01:30:15.000Z\",\n  \"requesterUserId\": \"<string>\",\n  \"dueDate\": {\n    \"year\": 123,\n    \"month\": 123,\n    \"day\": 123\n  },\n  \"waitUntil\": \"2025-01-15T01:30:15.000Z\",\n  \"nameTranslations\": {},\n  \"descriptionTranslations\": {},\n  \"categoryOptionId\": \"<string>\",\n  \"assignedToGroupId\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "friendlyIdentifier": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "completedAt": "2025-01-15T01:30:15.000Z",
    "escalatedAt": "2025-01-15T01:30:15.000Z",
    "createdByUserId": "<string>",
    "assignedToUserId": "<string>",
    "requesterUserId": "<string>",
    "statusId": "<string>",
    "escalationLevel": "AI",
    "priorityId": "<string>",
    "slaStartedAt": "2025-01-15T01:30:15.000Z",
    "slaBreachesAt": "2025-01-15T01:30:15.000Z",
    "labelIds": [
      "<string>"
    ],
    "type": "TICKET_TYPE_UNSPECIFIED",
    "dueDate": {
      "year": 123,
      "month": 123,
      "day": 123
    },
    "isOverdue": true,
    "dueAt": "2025-01-15T01:30:15.000Z",
    "childTicketIds": [
      "<string>"
    ],
    "linkedTicketIds": [
      "<string>"
    ],
    "duplicateTicketIds": [
      "<string>"
    ],
    "dependsOnTicketIds": [
      "<string>"
    ],
    "parentTicketId": "<string>",
    "conversationThreadTicketIds": [
      "<string>"
    ],
    "conversationThreadParentTicketId": "<string>",
    "nameTranslations": {},
    "descriptionTranslations": {},
    "categoryOptionId": "<string>",
    "assignedToGroupId": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Body

application/json

name

string | null

description

string | null

statusId

string | null

priorityId

string | null

assignedToUserId

string | null

labelIds

string[]

slaStartedAt

string<date-time> | null

deprecated

A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").

Example:

"2025-01-15T01:30:15.000Z"

slaBreachesAt

string<date-time> | null

deprecated

A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").

Example:

"2025-01-15T01:30:15.000Z"

escalationLevel

enum<string> | null

deprecated

Deprecated: escalation level is now automatically managed by assignment. Assigning to a user escalates to HUMAN; assigning to the system user de-escalates to AI. This field still works but will be removed in a future API version.

Available options:

AI,

HUMAN

requesterUserId

string | null

Optional. Reassigns who the ticket is requested for. Must be a user of the team's organization; deactivated users are allowed, so historical imports can name offboarded employees. API-key and worker callers may name any such user; user-token callers may name someone other than themselves only when they hold the set_ticket_requester permission on the team. The change is recorded in the org audit log and on the ticket timeline.

dueDate

Date · object | null

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:

A full date, with non-zero year, month, and day values.
A month and day, with a zero year (for example, an anniversary).
A year on its own, with a zero month and a zero day.
A year and month, with a zero day (for example, a credit card expiration date).

Related types:

[google.type.TimeOfDay][google.type.TimeOfDay]
[google.type.DateTime][google.type.DateTime]
[google.protobuf.Timestamp][google.protobuf.Timestamp]

Show child attributes

waitUntil

string<date-time> | null

A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").

Example:

"2025-01-15T01:30:15.000Z"

nameTranslations

name_translations · object

Upserts the provided translations (only touches languages included). A language with empty string value deletes that translation. When nil (not sent), existing translations are unchanged.

Show child attributes

descriptionTranslations

description_translations · object

Show child attributes

categoryOptionId

string | null

Optional. The category option ID to set on the ticket. May be a top-level category or any nested subcategory option. Set to an empty string to clear the ticket's category.

assignedToGroupId

string | null

Optional. The svauth group ID to set as the ticket's owning assignment group, independent of the individual assignee. Must be one of the team's assignable groups (see ListTicketAssignmentGroups). Set to an empty string to clear the owning group.

Response

200 - application/json

Success

data

data · object

Show child attributes

Update Ticket

curl --request PUT \
  --url https://public.api.serval.com/v2/tickets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "statusId": "<string>",
  "priorityId": "<string>",
  "assignedToUserId": "<string>",
  "labelIds": [
    "<string>"
  ],
  "slaStartedAt": "2025-01-15T01:30:15.000Z",
  "slaBreachesAt": "2025-01-15T01:30:15.000Z",
  "requesterUserId": "<string>",
  "dueDate": {
    "year": 123,
    "month": 123,
    "day": 123
  },
  "waitUntil": "2025-01-15T01:30:15.000Z",
  "nameTranslations": {},
  "descriptionTranslations": {},
  "categoryOptionId": "<string>",
  "assignedToGroupId": "<string>"
}
'

import requests

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

payload = {
    "name": "<string>",
    "description": "<string>",
    "statusId": "<string>",
    "priorityId": "<string>",
    "assignedToUserId": "<string>",
    "labelIds": ["<string>"],
    "slaStartedAt": "2025-01-15T01:30:15.000Z",
    "slaBreachesAt": "2025-01-15T01:30:15.000Z",
    "requesterUserId": "<string>",
    "dueDate": {
        "year": 123,
        "month": 123,
        "day": 123
    },
    "waitUntil": "2025-01-15T01:30:15.000Z",
    "nameTranslations": {},
    "descriptionTranslations": {},
    "categoryOptionId": "<string>",
    "assignedToGroupId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    statusId: '<string>',
    priorityId: '<string>',
    assignedToUserId: '<string>',
    labelIds: ['<string>'],
    slaStartedAt: '2025-01-15T01:30:15.000Z',
    slaBreachesAt: '2025-01-15T01:30:15.000Z',
    requesterUserId: '<string>',
    dueDate: {year: 123, month: 123, day: 123},
    waitUntil: '2025-01-15T01:30:15.000Z',
    nameTranslations: {},
    descriptionTranslations: {},
    categoryOptionId: '<string>',
    assignedToGroupId: '<string>'
  })
};

fetch('https://public.api.serval.com/v2/tickets/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'statusId' => '<string>',
    'priorityId' => '<string>',
    'assignedToUserId' => '<string>',
    'labelIds' => [
        '<string>'
    ],
    'slaStartedAt' => '2025-01-15T01:30:15.000Z',
    'slaBreachesAt' => '2025-01-15T01:30:15.000Z',
    'requesterUserId' => '<string>',
    'dueDate' => [
        'year' => 123,
        'month' => 123,
        'day' => 123
    ],
    'waitUntil' => '2025-01-15T01:30:15.000Z',
    'nameTranslations' => [
        
    ],
    'descriptionTranslations' => [
        
    ],
    'categoryOptionId' => '<string>',
    'assignedToGroupId' => '<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/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"statusId\": \"<string>\",\n  \"priorityId\": \"<string>\",\n  \"assignedToUserId\": \"<string>\",\n  \"labelIds\": [\n    \"<string>\"\n  ],\n  \"slaStartedAt\": \"2025-01-15T01:30:15.000Z\",\n  \"slaBreachesAt\": \"2025-01-15T01:30:15.000Z\",\n  \"requesterUserId\": \"<string>\",\n  \"dueDate\": {\n    \"year\": 123,\n    \"month\": 123,\n    \"day\": 123\n  },\n  \"waitUntil\": \"2025-01-15T01:30:15.000Z\",\n  \"nameTranslations\": {},\n  \"descriptionTranslations\": {},\n  \"categoryOptionId\": \"<string>\",\n  \"assignedToGroupId\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://public.api.serval.com/v2/tickets/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"statusId\": \"<string>\",\n  \"priorityId\": \"<string>\",\n  \"assignedToUserId\": \"<string>\",\n  \"labelIds\": [\n    \"<string>\"\n  ],\n  \"slaStartedAt\": \"2025-01-15T01:30:15.000Z\",\n  \"slaBreachesAt\": \"2025-01-15T01:30:15.000Z\",\n  \"requesterUserId\": \"<string>\",\n  \"dueDate\": {\n    \"year\": 123,\n    \"month\": 123,\n    \"day\": 123\n  },\n  \"waitUntil\": \"2025-01-15T01:30:15.000Z\",\n  \"nameTranslations\": {},\n  \"descriptionTranslations\": {},\n  \"categoryOptionId\": \"<string>\",\n  \"assignedToGroupId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"statusId\": \"<string>\",\n  \"priorityId\": \"<string>\",\n  \"assignedToUserId\": \"<string>\",\n  \"labelIds\": [\n    \"<string>\"\n  ],\n  \"slaStartedAt\": \"2025-01-15T01:30:15.000Z\",\n  \"slaBreachesAt\": \"2025-01-15T01:30:15.000Z\",\n  \"requesterUserId\": \"<string>\",\n  \"dueDate\": {\n    \"year\": 123,\n    \"month\": 123,\n    \"day\": 123\n  },\n  \"waitUntil\": \"2025-01-15T01:30:15.000Z\",\n  \"nameTranslations\": {},\n  \"descriptionTranslations\": {},\n  \"categoryOptionId\": \"<string>\",\n  \"assignedToGroupId\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "friendlyIdentifier": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "completedAt": "2025-01-15T01:30:15.000Z",
    "escalatedAt": "2025-01-15T01:30:15.000Z",
    "createdByUserId": "<string>",
    "assignedToUserId": "<string>",
    "requesterUserId": "<string>",
    "statusId": "<string>",
    "escalationLevel": "AI",
    "priorityId": "<string>",
    "slaStartedAt": "2025-01-15T01:30:15.000Z",
    "slaBreachesAt": "2025-01-15T01:30:15.000Z",
    "labelIds": [
      "<string>"
    ],
    "type": "TICKET_TYPE_UNSPECIFIED",
    "dueDate": {
      "year": 123,
      "month": 123,
      "day": 123
    },
    "isOverdue": true,
    "dueAt": "2025-01-15T01:30:15.000Z",
    "childTicketIds": [
      "<string>"
    ],
    "linkedTicketIds": [
      "<string>"
    ],
    "duplicateTicketIds": [
      "<string>"
    ],
    "dependsOnTicketIds": [
      "<string>"
    ],
    "parentTicketId": "<string>",
    "conversationThreadTicketIds": [
      "<string>"
    ],
    "conversationThreadParentTicketId": "<string>",
    "nameTranslations": {},
    "descriptionTranslations": {},
    "categoryOptionId": "<string>",
    "assignedToGroupId": "<string>"
  }
}