# Create a custom field

**POST /api/v1/custom-field**




## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters



### Body: application/json (object)

- **type** (string)
  |

  The custom field type. Available options: string, number, selection, boolean, datetime and longtext

  | Value | Description |
  | ----- | ----------- |
  |string|String|
  |number|Number|
  |selection|Selection|
  |boolean|Boolean|
  |datetime|Datetime|
  |longtext|Longtext|
- **name** (string)
  The name of the custom field. Must be unique for the model_type.
- **is_required** (boolean)
  Denotes if the custom field is required. If required, it must be specified when creating/updating a model.
- **model_type** (string)
  The type of model the custom field applies for. Available options: client, board_task, case, plan, task
- **help_text** (string)
  Optional help text to aide the custom field. Will be displayed on Plannr.
- **selection_options** (array)
  If the type is "selection" this array must be provided. This is the array of available options for the selection box.
- **is_visible_to_clients** (boolean)
  Denotes if the custom field is visible and editable to clients and their fact-finds.


## Responses
### 200


#### Body: application/json (object)
- **uuid** (string)
  The UUID of the custom field
- **created_at** (string)
  The timestamp of when the resource was created.
- **updated_at** (string)
  The timestamp of when the resource was updated.
- **type** (string)
  The type of custom field
- **name** (string)
  The name of the custom field
- **reference** (string)
  The reference of the custom field, used when updating the custom field on the model.
- **is_required** (boolean)
  Denotes if the custom field is required
- **model_type** (string)
  The type of model that the custom field is for.
- **help_text** (string)
  Optional help text to aide the custom field. Will be displayed on Plannr.
- **firm** (object)
  The custom field firm
- **selection_options** (array[string])
  This is the array of available options for the selection box. If the type is "selection" this array will be provided.
- **is_visible_to_clients** (boolean)
  Denotes if the custom field is visible and editable to clients.
- **position** (integer)
  The position of the custom field


[Powered by Bump.sh](https://bump.sh)