Skip to main content
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."
}
'
{
  "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"
  }
}

Authorizations

​
slog-api-key
string
header
required

API key obtained from the Slog dashboard or returned by the signup/invite-redeem flows. Pass as the slog-api-key header.

Path Parameters

​
id
string
required

Resource ID (UPID) or, for tasks and projects, the human-readable reference such as ENG-42.

Body

application/json

All fields are optional. key and type cannot be changed after creation.

​
name
string
Minimum string length: 1
Example:

"Story Points"

​
description
string | null
Example:

"Updated description."

​
presentation
string | null
Example:

null

​
metadata
object
Example:
{}
​
recordTypes
string[]
Example:
["task", "project"]

Response

The updated field definition.

​
field
object