Skip to main content
PATCH
Update a field definition

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:

Response

The updated field definition.

field
object