---
title: "Create one new contact field for this Hive workspace."
method: POST
path: "/api/v1/tools/create_contact_field"
---

# Create one new contact field for this Hive workspace.

`POST /api/v1/tools/create_contact_field`

## Request

- Base URL: `https://hivepublish.com`
- URL: `https://hivepublish.com/api/v1/tools/create_contact_field`
- Auth: HTTP bearer

## Headers

- `Idempotency-Key` string, required

## Request body

- object
  - `key` string, required: The stable key automations refer to it by.
  - `label` string, required: What people see on screen.
  - `type` 'text' | 'email' | 'phone' | 'number' | 'date' | 'date_time' | 'boolean' | 'choice' | 'array' | 'url', required: What kind of value it holds.
  - `options` string[]: The allowed values, for a choice field.

## Response `200`

Tool result

- ToolResult
  - `data` unknown, required
  - `meta` object, required
    - `tool` string
    - `workspaceId` string, uuid

## Other responses

- `400`: Invalid input
- `401`: Missing or invalid credential
- `403`: Missing workspace scope, role permission, or plan entitlement
- `409`: Idempotency conflict, replay, or request still in progress
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/hivepublish/apis/hive-developer-api.md) · [All operations](https://skmtc.dev/hivepublish/apis/hive-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hivepublish/apis/hive-developer-api/revisions/b440c763583e?raw)