---
title: "Create a custom field definition"
method: POST
path: "/customFieldDefinition"
tags: ["Custom Field"]
---

# Create a custom field definition

`POST /customFieldDefinition`

## Request

- Base URL: `https://api.app.subskribe.com`
- URL: `https://api.app.subskribe.com/customFieldDefinition`
- Auth: API key in header `X-API-Key`

Creates a new custom field definition for your tenant. On success the id of the custom field definition is returned.

## Request body

- CustomFieldDefinitionCreateInput
  - `parentObjectType` 'ACCOUNT' | 'ORDER' | 'ORDER_ITEM' | 'PLAN' | 'CHARGE' | 'INVOICE' | 'SALES_ROOM' | 'SUBSCRIPTION' | 'SUBSCRIPTION_ITEM' | 'OPPORTUNITY', required
  - `fieldType` 'STRING' | 'PICKLIST' | 'MULTISELECT_PICKLIST', required
  - `fieldName` string
  - `fieldLabel` string
  - `options` string[]
  - `required` boolean
  - `source` 'USER' | 'SYSTEM'
  - `defaultValue` CustomFieldDefault
    - `value` string
    - `selections` string[]

## Response `200`

successful operation

- string

---

[API](https://skmtc.dev/dealhub/apis/subskribe-api.md) - [All operations](https://skmtc.dev/dealhub/apis/subskribe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dealhub/apis/subskribe-api/revisions/c1ee531b82ce?raw)