Skip to main content
POST
Update field

Restrictions

Usage

  • Only display_name, description, options, and default_value can be changed; field_name, field_type, and value_type are immutable.
  • options and default_value must remain consistent with the field’s existing type — same rules as create.
  • Audited — changes are recorded in the audit log.

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json
field_id
string
required

Field ID — 24-character hex ObjectID.

Pattern: ^[a-f0-9]{24}$
display_name
string

New display name. Must remain unique within the account.

Maximum string length: 39
description
string

New description.

options
string[]

Replacement options list. Must obey the same per-type rules as create.

default_value

Replacement default value. Type must match the field's existing field_type.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
required

Endpoint-specific payload. See each operation's 200 response schema.