Skip to main content
POST
Delete field

Restrictions

Usage

  • The field is marked deleted synchronously; clearing its values from historical incidents runs in the background and may take time on large datasets.
  • Re-creating a field with the same field_name is only allowed if field_type and value_type match the deleted entry.
  • Deletion is rejected with ReferenceExist and the referencing custom forms in data.refs until no form uses the field.
  • 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}$

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.