---
title: "uptimeify_custom_field"
description: "A custom field of the customer master data (organization token with write access). The API never deletes a field: destroying it deactivates it, and creating a field whose field_key belongs to a deactivated one reactivates that field (same id) with the configured values, so customer values stored under the key come back. An active field with the key answers 409; import it instead. A field deactivated outside Terraform counts as gone. Import with the numeric id."
---

A custom field of the customer master data (organization token with write access). The API never deletes a field: destroying it deactivates it, and creating a field whose `field_key` belongs to a deactivated one reactivates that field (same id) with the configured values, so customer values stored under the key come back. An active field with the key answers 409; import it instead. A field deactivated outside Terraform counts as gone. Import with the numeric id.

## Example Usage

```terraform
resource "uptimeify_custom_field" "contract" {
  name      = "Contract"
  field_key = "contract"
}

resource "uptimeify_custom_field" "tier" {
  name       = "Support tier"
  field_type = "select"
  options    = ["basic", "premium"]
}
```

## Schema

### Required

- `name` (String)

### Optional

- `display_order` (Number)
- `field_key` (String) Key in the customer's `custom_fields`: lower-case letters, digits, single underscores. Unset = derived from `name`.
- `field_type` (String) `text`, `number`, `email`, `url`, `select`. Default `text`.
- `help_text` (String)
- `is_required` (Boolean)
- `options` (List of String) Choices of a `select` field, at most 50 of up to 100 characters.
- `placeholder` (String)
- `show_in_table` (Boolean) Show as a column in the customer list.

### Read-Only

- `created_at` (String)
- `id` (String) Numeric field id.
- `organization_id` (Number)
- `updated_at` (String)

## Import

Import is supported using the following syntax:

The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:

```shell
terraform import uptimeify_custom_field.contract 5
```