Skip to main content
POST
Delete field

Restrictions

Usage

  • If a custom form references the field, the call returns HTTP 400 ReferenceExist with the referencing forms in data.refs; remove the references first.
  • The field is marked deleted right away. A background job then removes its value from existing incidents and finally removes the field record.
  • Deleting an already-deleted field succeeds without change; an unknown field_id returns InvalidParameter.
  • The field_name can be reused later only with the same field_type and value_type.
  • 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}$

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.