Skip to main content

​
moss custom-field list

List custom field definitions. 
moss custom-field list
moss custom-field list --entity-type contact
OptionRequiredDescription
--entity-type <type>NoFilter by entity type: contact, company, or deal
--page <n>NoPage number
--per-page <n>NoItems per page
--sort <field>NoSort field
--order <dir>NoSort order (asc or desc)

​
moss custom-field show

Show a custom field definition. 
moss custom-field show --id cfd_abc123
OptionRequiredDescription
--id <id>YesCustom field definition ID

​
moss custom-field create

Create a new custom field definition. 
moss custom-field create \
  --entity-type contact \
  --field-name "contract_tier" \
  --field-label "Contract Tier" \
  --field-type select \
  --field-options "starter,pro,enterprise" \
  --required
OptionRequiredDescription
--entity-type <type>YesEntity type: contact, company, or deal
--field-name <name>YesField name in snake_case
--field-label <label>YesHuman-readable display label
--field-type <type>YesField type: text, number, date, select, url, or boolean
--field-options <opts>NoComma-separated options (for select type)
--requiredNoMark field as required
--display-order <n>NoDisplay order (default: 0)

​
moss custom-field update

Update a custom field definition. Field name and type cannot be changed after creation. 
moss custom-field update --id cfd_abc123 --field-label "Support Tier"
OptionRequiredDescription
--id <id>YesCustom field definition ID
--field-label <label>NoDisplay label
--field-options <opts>NoComma-separated options (for select type)
--required <bool>NoRequired: true or false
--display-order <n>NoDisplay order

​
moss custom-field delete

Delete a custom field definition. This also removes all values of this field from all entities. 
moss custom-field delete --id cfd_abc123
OptionRequiredDescription
--id <id>YesCustom field definition ID