---
title: "Rename, describe, retype (converting stored values, or 409 with an example that doesn't fit), change choices, or hide a field."
method: PATCH
path: "/v1/workspaces/{workspaceId}/contact-fields/{key}"
---

# Rename, describe, retype (converting stored values, or 409 with an example that doesn't fit), change choices, or hide a field.

`PATCH /v1/workspaces/{workspaceId}/contact-fields/{key}`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/contact-fields/{key}`
- Auth: HTTP bearer

## Request body

- object
  - `label` string
  - `description` string
  - `type` 'text' | 'number' | 'boolean' | 'date' | 'choice' | 'choices'
  - `options` string[]
  - `status` 'active' | 'hidden'

## Response `200`

Successful response.

- object
  - `data` ContactField, required
    - `key` string, required
    - `label` string, required
    - `description` string, required
    - `type` 'text' | 'number' | 'boolean' | 'date' | 'choice' | 'choices', required
    - `options` string[], required
    - `origin` 'system' | 'person' | 'agent' | 'form' | 'import' | 'api' | 'event' | 'discovered', required
    - `status` 'active' | 'hidden', required
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `operators` string[]
    - `contacts_with_value` integer

## Other responses

- `404`: The requested resource does not exist in this workspace.
- `409`: Built-in field, or stored values don't fit the new type.

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/0705eb6ef2bc?raw)