Create Status - Serval Documentation

POST

statuses

Create Status

curl --request POST \
  --url https://public.api.serval.com/v2/statuses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "color": "<string>",
  "isAiSelectable": true,
  "emoji": "<string>",
  "locked": true,
  "isDefault": true,
  "scopedId": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/statuses"

payload = {
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "color": "<string>",
    "isAiSelectable": True,
    "emoji": "<string>",
    "locked": True,
    "isDefault": True,
    "scopedId": "<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>',
    name: '<string>',
    description: '<string>',
    color: '<string>',
    isAiSelectable: true,
    emoji: '<string>',
    locked: true,
    isDefault: true,
    scopedId: '<string>'
  })
};

fetch('https://public.api.serval.com/v2/statuses', 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/statuses",
  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>',
    'name' => '<string>',
    'description' => '<string>',
    'color' => '<string>',
    'isAiSelectable' => true,
    'emoji' => '<string>',
    'locked' => true,
    'isDefault' => true,
    'scopedId' => '<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/statuses"

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\",\n  \"isAiSelectable\": true,\n  \"emoji\": \"<string>\",\n  \"locked\": true,\n  \"isDefault\": true,\n  \"scopedId\": \"<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/statuses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\",\n  \"isAiSelectable\": true,\n  \"emoji\": \"<string>\",\n  \"locked\": true,\n  \"isDefault\": true,\n  \"scopedId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/statuses")

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  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\",\n  \"isAiSelectable\": true,\n  \"emoji\": \"<string>\",\n  \"locked\": true,\n  \"isDefault\": true,\n  \"scopedId\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "statusGroup": "TICKET_STATUS_GROUP_UNSPECIFIED",
    "name": "<string>",
    "description": "<string>",
    "isDefault": true,
    "ticketType": "TICKET_TYPE_UNSPECIFIED",
    "scopedId": "<string>",
    "color": "<string>",
    "isAiSelectable": true,
    "emoji": "<string>",
    "locked": true
  }
}

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.

Authorizations

Authorization

string

header

required

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

Body

application/json

ticketType

enum<string>

required

Required. The status pool this status belongs to (e.g. TICKET_TYPE_REQUEST). There is no shared/default pool, so TICKET_TYPE_UNSPECIFIED is rejected.

Available options:

TICKET_TYPE_UNSPECIFIED,

TICKET_TYPE_REQUEST,

TICKET_TYPE_TASK,

TICKET_TYPE_MAJOR_INCIDENT,

TICKET_TYPE_CONVERSATION,

TICKET_TYPE_JOURNEY,

TICKET_TYPE_INCIDENT,

TICKET_TYPE_CHANGE,

TICKET_TYPE_CUSTOM,

TICKET_TYPE_PROBLEM

teamId

string

statusGroup

enum<string>

Available options:

TICKET_STATUS_GROUP_UNSPECIFIED,

TODO,

IN_PROGRESS,

DONE,

CANCELED

name

string

description

string | null

color

string | null

isAiSelectable

boolean | null

emoji

string | null

locked

boolean | null

isDefault

boolean | null

scopedId

string | null

The team-portable identity of the status. Omit to mint a new one; set it to preserve identity across teams (used by config push / Resource Manager).

Response

200 - application/json

Success

data

data · object

Show child attributes

Create Status

curl --request POST \
  --url https://public.api.serval.com/v2/statuses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "color": "<string>",
  "isAiSelectable": true,
  "emoji": "<string>",
  "locked": true,
  "isDefault": true,
  "scopedId": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/statuses"

payload = {
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "color": "<string>",
    "isAiSelectable": True,
    "emoji": "<string>",
    "locked": True,
    "isDefault": True,
    "scopedId": "<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>',
    name: '<string>',
    description: '<string>',
    color: '<string>',
    isAiSelectable: true,
    emoji: '<string>',
    locked: true,
    isDefault: true,
    scopedId: '<string>'
  })
};

fetch('https://public.api.serval.com/v2/statuses', 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/statuses",
  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>',
    'name' => '<string>',
    'description' => '<string>',
    'color' => '<string>',
    'isAiSelectable' => true,
    'emoji' => '<string>',
    'locked' => true,
    'isDefault' => true,
    'scopedId' => '<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/statuses"

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\",\n  \"isAiSelectable\": true,\n  \"emoji\": \"<string>\",\n  \"locked\": true,\n  \"isDefault\": true,\n  \"scopedId\": \"<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/statuses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\",\n  \"isAiSelectable\": true,\n  \"emoji\": \"<string>\",\n  \"locked\": true,\n  \"isDefault\": true,\n  \"scopedId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/statuses")

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  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"color\": \"<string>\",\n  \"isAiSelectable\": true,\n  \"emoji\": \"<string>\",\n  \"locked\": true,\n  \"isDefault\": true,\n  \"scopedId\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "statusGroup": "TICKET_STATUS_GROUP_UNSPECIFIED",
    "name": "<string>",
    "description": "<string>",
    "isDefault": true,
    "ticketType": "TICKET_TYPE_UNSPECIFIED",
    "scopedId": "<string>",
    "color": "<string>",
    "isAiSelectable": true,
    "emoji": "<string>",
    "locked": true
  }
}

​Authentication and permissions

Authorizations

Body

Response

Authentication and permissions