---
title: "Create custom field"
method: POST
path: "/custom-fields/field"
tags: ["Custom Fields"]
---

# Create custom field

`POST /custom-fields/field`

REQUIRED SCOPES <code>['custom-fields:write']</code><br>In addition to the 4 fields available by default (First name, Last name, Phone Number, Email address), this API endpoint allows for creating and adding a new custom field to the ones that already exist. <br><br>As a result, each user in the system can now narrow down the search among their contacts and individualize messages. <br><br>To create a new custom field for your contacts, you have two things to select: <strong>Field Name</strong> which is a recognizable title for your custom property (i.e `Birthday`) and <strong>Field Type.</strong> <br><br>The values that are allowed for Field Types include: <ul> <li>Text</li> <li>URL</li> <li>Date</li> <li>Number</li> </ul> <p>As a result, inside the conversation window, on the user contact card, there&rsquo;s new data available for view. You can choose whethe to show custom information on the user contact card or not.</p>

## Query parameters

- `name` string, required
- `type` 'text' | 'url' | 'date' | 'number' | 'datetime', required
- `visible` boolean, required

## Response `200`

OK

- object
  - `status` string
  - `data` CustomFieldResource — Class CustomFieldResource
    - `id` integer
    - `organization_id` integer
    - `key` string
    - `name` string
    - `type` string
    - `visible` integer

## Other responses

- `500` — Error

---

[API](https://skmtc.net/salesmessage/apis/salesmessage-public-api.md) · [All operations](https://skmtc.net/salesmessage/apis/salesmessage-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/salesmessage/salesmessage-public-api/revisions/e96b3e58b041/schema)