---
title: "Create a custom-field definition"
method: POST
path: "/contacts/custom-fields"
tags: ["Contacts"]
---

# Create a custom-field definition

`POST /contacts/custom-fields`

## Request

- Base URL: `https://www.sociahive.com/api/v1`
- URL: `https://www.sociahive.com/api/v1/contacts/custom-fields`
- Auth: one of:
  - API key in header `X-API-Key`
  - OAuth 2 (authorization code, authorization URL `/api/oauth/authorize`, token URL `/api/oauth/token`, scopes: `contacts:write`)

## Request body

- object
  - `key` string, required
  - `label` string, required
  - `type` 'text' | 'number' | 'date' | 'boolean' | 'select', required

## Response `201`

Field created

- ObjectEnvelope: Generic `{ data: <object> }` envelope.
  - `data` object, required

## Other responses

- `400`: Bad request — invalid parameters
- `401`: Authentication required — provide X-API-Key or Bearer token
- `403`: Insufficient scope for this operation
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/sociahive/apis/sociahive-api.md) · [All operations](https://skmtc.dev/sociahive/apis/sociahive-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sociahive/apis/sociahive-api/revisions/791b8548d288?raw)