Skip to main content
POST
Update field

Restrictions

Usage

  • display_name, description, options and default_value are all overwritten with the request values on every call; a field left out is cleared. Always send the full desired values.
  • field_name, field_type and value_type cannot change; options and default_value must satisfy the type rules of create.
  • An unknown field_id returns InvalidParameter; display_name must stay unique among non-deleted fields.
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json
field_id
string
required

Field ID — 24-character hex ObjectID.

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

New display name (max 39 characters); must stay unique among non-deleted fields. Always written.

Maximum string length: 39
description
string

New description. Always written: omitting it clears the description.

options
string[]

Replacement options list. Must obey the same per-type rules as create. Note: the update always overwrites display_name, description, options, and default_value with the submitted values, so for single_select/multi_select fields a non-empty options list must be sent on every update.

default_value

New default value; its type must match the field's field_type. Always written: omitting it clears the default.

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

Operation-specific payload, documented in each operation's 200 response. Operations without a payload return {} or omit data entirely.