Skip to main content
POST
Create field

Restrictions

Usage

  • Requires the Standard plan or higher; otherwise NoLicense.
  • An account holds at most 15 non-deleted custom fields by default (some accounts have a higher limit); exceeding it returns InvalidParameter.
  • field_name is 1–39 characters matching ^[a-zA-Z_][a-zA-Z0-9_]*$, unique, and immutable. The name of a deleted field can be reused only with the same field_type and value_type. display_name must be unique among non-deleted fields.
  • Type rules: checkbox requires value_type=bool and no options; single_select/multi_select require value_type=string and a non-empty list of unique options; text requires value_type=string and no options.
  • The response contains only field_id and field_name; use /field/info for the full object.
  • Concurrent create calls in one account return RequestTooFrequently.
  • 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_name
string
required

Machine name: 1–39 characters of [a-zA-Z0-9_], starting with a letter or underscore. Immutable after creation.

Maximum string length: 39
Pattern: ^[a-zA-Z_][a-zA-Z0-9_]{0,39}$
display_name
string
required

Human-readable name. Must be unique within the account.

Maximum string length: 39
field_type
enum<string>
required

Field type, immutable after creation.

Available options:
checkbox,
multi_select,
single_select,
text
value_type
enum<string>
required

Value type. checkbox requires bool; all other types require string. Immutable after creation. float is a reserved value currently rejected for every field_type.

Available options:
string,
bool,
float
description
string

Optional free-text description.

Maximum string length: 499
options
string[]

Required and non-empty for single_select/multi_select (unique strings, each 1–200 chars). Must be omitted or empty for checkbox/text.

default_value

Optional default value. Type must match field_type: bool for checkbox; one of options for single_select; subset of options for multi_select; string ≤3000 chars for text.

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.