Entity Type API

Update Entity Type Field

Update an entity type field: set its description, rename it (set name), or change its data type (set data_type, plus enum_options when the new type is ENUM/MULTI_SELECT). At most one attribute may change per request. Description edits apply immediately and return an empty schema_migration_id; an empty description clears it. Rename and data-type changes return schema_migration_id, which you poll via Get Schema Migration to track completion.

PUT

entity-type-fields

{id}

curl --request PUT \
  --url https://public.api.serval.com/v2/entity-type-fields/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "enumOptions": [
    {
      "value": "<string>",
      "displayName": "<string>",
      "displayOrder": 123,
      "description": "<string>"
    }
  ],
  "description": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/entity-type-fields/{id}"

payload = {
    "name": "<string>",
    "enumOptions": [
        {
            "value": "<string>",
            "displayName": "<string>",
            "displayOrder": 123,
            "description": "<string>"
        }
    ],
    "description": "<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>',
    enumOptions: [
      {
        value: '<string>',
        displayName: '<string>',
        displayOrder: 123,
        description: '<string>'
      }
    ],
    description: '<string>'
  })
};

fetch('https://public.api.serval.com/v2/entity-type-fields/{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/entity-type-fields/{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>',
    'enumOptions' => [
        [
                'value' => '<string>',
                'displayName' => '<string>',
                'displayOrder' => 123,
                'description' => '<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/entity-type-fields/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"enumOptions\": [\n    {\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"displayOrder\": 123,\n      \"description\": \"<string>\"\n    }\n  ],\n  \"description\": \"<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/entity-type-fields/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"enumOptions\": [\n    {\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"displayOrder\": 123,\n      \"description\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/entity-type-fields/{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  \"enumOptions\": [\n    {\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"displayOrder\": 123,\n      \"description\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\"\n}"

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

{
  "data": {
    "schemaMigrationId": "<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	`entities:write`
Team-scoped API key	`entities: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

string

required

The ID of the entity type field to update.

Body

application/json

name

string | null

New display name. When provided and different from the current name, the field is renamed (key re-derived via slugify). Omit to leave unchanged.

dataType

enum<string> | null

New data type. When provided and different from the current type, the field's type is changed and existing values are converted. Omit to leave unchanged.

Available options:

DATA_TYPE_UNSPECIFIED,

TEXT,

NUMBER,

BOOL,

TIMESTAMP,

ENUM,

ENTITY_REF,

USER_REF,

UNIQUE,

MULTI_SELECT,

FILE,

TICKET_REF,

TIMESTAMP_RANGE

enumOptions

EnumOptionInput · object[]

Required when data_type is changing to ENUM or MULTI_SELECT: the option set for the converted field.

Show child attributes

description

string | null

Set or clear descriptive guidance without a schema migration. Omit to preserve. Send separately from a rename or data-type change.

Response

200 - application/json

Success

data

data · object

Reference to the staged migration applying the change. data.schema_migration_id is empty if the request was a no-op. At most one attribute may change per request. Description edits return an empty migration id immediately.

Show child attributes

Update Entity Type Field

curl --request PUT \
  --url https://public.api.serval.com/v2/entity-type-fields/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "enumOptions": [
    {
      "value": "<string>",
      "displayName": "<string>",
      "displayOrder": 123,
      "description": "<string>"
    }
  ],
  "description": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/entity-type-fields/{id}"

payload = {
    "name": "<string>",
    "enumOptions": [
        {
            "value": "<string>",
            "displayName": "<string>",
            "displayOrder": 123,
            "description": "<string>"
        }
    ],
    "description": "<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>',
    enumOptions: [
      {
        value: '<string>',
        displayName: '<string>',
        displayOrder: 123,
        description: '<string>'
      }
    ],
    description: '<string>'
  })
};

fetch('https://public.api.serval.com/v2/entity-type-fields/{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/entity-type-fields/{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>',
    'enumOptions' => [
        [
                'value' => '<string>',
                'displayName' => '<string>',
                'displayOrder' => 123,
                'description' => '<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/entity-type-fields/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"enumOptions\": [\n    {\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"displayOrder\": 123,\n      \"description\": \"<string>\"\n    }\n  ],\n  \"description\": \"<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/entity-type-fields/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"enumOptions\": [\n    {\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"displayOrder\": 123,\n      \"description\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/entity-type-fields/{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  \"enumOptions\": [\n    {\n      \"value\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"displayOrder\": 123,\n      \"description\": \"<string>\"\n    }\n  ],\n  \"description\": \"<string>\"\n}"

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

{
  "data": {
    "schemaMigrationId": "<string>"
  }
}

Get started

Authentication

Endpoints

Development

Update Entity Type Field

Authentication and permissions

Authorizations

Path Parameters

Body

Response

​Authentication and permissions

Authorizations

Path Parameters

Body

Response

Authentication and permissions