---
title: "Create Custom Fields for Customers"
method: POST
path: "/v3/field"
---

# Create Custom Fields for Customers

`POST /v3/field`

You can create custom fields for your customers which you would then pass into the create customer route

## Query parameters

- `merchantId` integer, required
- `echo` boolean

## Request body

- object
  - `id` string — Id for the custom field (Auto-generated by server)
  - `name` string — Descriptor name for the custom field
  - `fieldName` string, required — Name for the custom field object
  - `fieldDataType` string, required — Type of field. Values: Boolean, String, Integer, Decimal, or List
  - `fieldSourceType` string, required — Always customer
  - `isDeleted` boolean, required — System level field (Always False)
  - `isSystem` boolean, required — System Level Field (Always False)
  - `isRequired` boolean, required — Noting if the custom field is required to fill out
  - `options` object[] — Only required for Boolean and List. Name and Value should match.
    - `name` string, required — Name of Option
    - `value` string, required — Value (same as name)

## Response `201`

201

- object
  - `id` integer
  - `fieldName` string
  - `fieldDataType` string
  - `fieldSourceType` string
  - `isSystem` boolean
  - `isDeleted` boolean
  - `isRequired` boolean
  - `options` object[]

---

[API](https://skmtc.net/mxmerchant/apis/checkout-api.md) · [All operations](https://skmtc.net/mxmerchant/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mxmerchant/checkout-api/versions/6807b698abcb/schema)