---
title: "Declare a contact field: label, type (text, number, boolean, date, choice, choices), optional key, options and description."
method: POST
path: "/v1/workspaces/{workspaceId}/contact-fields"
---

# Declare a contact field: label, type (text, number, boolean, date, choice, choices), optional key, options and description.

`POST /v1/workspaces/{workspaceId}/contact-fields`

## Request

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

## Request body

- object
  - `key` string
  - `label` string, required
  - `description` string
  - `type` 'text' | 'number' | 'boolean' | 'date' | 'choice' | 'choices'
  - `options` string[]

## Response `201`

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

- `409`: A field with that key already exists.

---

[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/a149909267f9?raw)