Fields
Update a field definition
Partially updates a custom field definition. key and type are immutable
after creation. Requires ADMIN or OWNER workspace role.
PATCH
/
fields
/
{id}
Update a field definition
curl --request PATCH \
--url https://slog.ai/fields/{id} \
--header 'Content-Type: application/json' \
--header 'slog-api-key: <api-key>' \
--data '
{
"name": "Story Points",
"description": "Updated description."
}
'import requests
url = "https://slog.ai/fields/{id}"
payload = {
"name": "Story Points",
"description": "Updated description."
}
headers = {
"slog-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'slog-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Story Points', description: 'Updated description.'})
};
fetch('https://slog.ai/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://slog.ai/fields/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Story Points',
'description' => 'Updated description.'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"slog-api-key: <api-key>"
],
]);
$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://slog.ai/fields/{id}"
payload := strings.NewReader("{\n \"name\": \"Story Points\",\n \"description\": \"Updated description.\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("slog-api-key", "<api-key>")
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.patch("https://slog.ai/fields/{id}")
.header("slog-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Story Points\",\n \"description\": \"Updated description.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://slog.ai/fields/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["slog-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Story Points\",\n \"description\": \"Updated description.\"\n}"
response = http.request(request)
puts response.read_body{
"field": {
"id": "fdef_01jqfield0001",
"key": "sprint_points",
"name": "Sprint Points",
"description": "Story-point estimate for sprint planning.",
"type": "number",
"presentation": null,
"metadata": {},
"recordTypes": [
"task"
],
"isBuiltIn": false,
"createdAt": "2026-05-01T10:00:00.000Z",
"updatedAt": "2026-05-01T10:00:00.000Z"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "teamId is required"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Requires ADMIN or OWNER role"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Task not found"
}
}Authorizations
ApiKeyBearerToken
API key obtained from the Slog dashboard or returned by the signup/invite-redeem
flows. Pass as the slog-api-key header.
Path Parameters
Resource ID (UPID) or, for tasks and projects, the human-readable reference such
as ENG-42.
Body
application/json
Response
The updated field definition.
Show child attributes
Show child attributes
⌘I
Update a field definition
curl --request PATCH \
--url https://slog.ai/fields/{id} \
--header 'Content-Type: application/json' \
--header 'slog-api-key: <api-key>' \
--data '
{
"name": "Story Points",
"description": "Updated description."
}
'import requests
url = "https://slog.ai/fields/{id}"
payload = {
"name": "Story Points",
"description": "Updated description."
}
headers = {
"slog-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'slog-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Story Points', description: 'Updated description.'})
};
fetch('https://slog.ai/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://slog.ai/fields/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Story Points',
'description' => 'Updated description.'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"slog-api-key: <api-key>"
],
]);
$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://slog.ai/fields/{id}"
payload := strings.NewReader("{\n \"name\": \"Story Points\",\n \"description\": \"Updated description.\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("slog-api-key", "<api-key>")
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.patch("https://slog.ai/fields/{id}")
.header("slog-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Story Points\",\n \"description\": \"Updated description.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://slog.ai/fields/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["slog-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Story Points\",\n \"description\": \"Updated description.\"\n}"
response = http.request(request)
puts response.read_body{
"field": {
"id": "fdef_01jqfield0001",
"key": "sprint_points",
"name": "Sprint Points",
"description": "Story-point estimate for sprint planning.",
"type": "number",
"presentation": null,
"metadata": {},
"recordTypes": [
"task"
],
"isBuiltIn": false,
"createdAt": "2026-05-01T10:00:00.000Z",
"updatedAt": "2026-05-01T10:00:00.000Z"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "teamId is required"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Requires ADMIN or OWNER role"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Task not found"
}
}