---
title: "addCustomField"
canonical: "https://support.appfire.com/space/JCLI/70784485/addCustomField"
format: markdown
---
> Macro (aura-html)

See also: [Actions](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70787366)

> Macro (details)
> 
> | **Description** | Add a new custom field. Type must be a valid custom field type key. Optionally, search can be a valid search template key. If '--options createAnother' is specified, a new custom field will be added even if a custom field exists with the same name. Use continue to ignore an already exists error. If the reference parameter is provided, a replacement variable of that name will be set to the custom field's numeric id. |
> | --- | --- |
> | **Required Parameters** | [field](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70784837), [type](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70785826) |
> | **Optional Parameters** | [description](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70785189), [search](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70784395), [reference](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70789847), [continue](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70790023), [options](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70784233) |
> | **Type** | [Create](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70780909/Action+Types#ActionTypes-Create) |
> | **Category** | [Fields](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70780591/Action+Categories#ActionCategories-Fields) |
> | **Output Formats** |  |
> | **Replacement Variables** | field, customFieldId |
> | **Hosting** | cloud,server,datacenter |
> | **Since Version** |  |
> | **Examples** | [addCustomField](https://appfire.atlassian.net/wiki/spaces/JCLI/pages/70782732/Examples#Examples-addCustomField) |

## Related How To's

> Macro (cql-query)