Less Annoying CRM
LACRM
Custom Fields
Retrieve and edit information on custom fields for contacts and pipelines in your account.
These functions correspond to the Custom Fields settings page in your account.
Create a custom field
This function will create a new custom field. Custom fields can be used on both contact and company records. Only account administrators can create custom contact fields.
The name of the custom field
Contact, Company, PipelineThe type of record this field is associated with.
Dropdown, Checkbox, Number, Date, Text, TextArea, ContactLink, FileLink, Currency, SectionThe type of field you'd like to create.
If this is a pipeline field, the id of the pipeline this field is attached to.
Whether a field is required. Checkbox and TextArea fields cannot be required.
Whether this field will display on active pipeline item badge.
Whether this field will display on closed pipeline item badge.
Whether this field will display on pipeline report.
Whether this field will use the International Format to display information. Only applies to Number fields.
The options for a dropdown or checkbox field. All other fields can skip this parameter.
For date fields only; indicates if the field should populate the calendar or not.
For date fields only; indicates if the date is one-time or if it repeats annually.
For date fields, the settings to customize the appearance of the field on the user's calendar.
object with the following fields:Text, Icon, IconTextIf ShowOnCalendar is set, indicates if the field should show as text, an icon, or both.
If Icon or IconText is set for Display, the name of the icon to use.
If Text or IconText is set for Display, the text to use. If nothing is set, will default to the name of the field.
For link fields, indicates if the field can support one or multiple contacts.
For field sections, the settings to customize the appearance of the section.
object with the following fields:The icon for the section.
The color for the section.
If the section should be collapsed by default.
For currency fields, the settings to customize the appearance of the field.
object with the following fields:$, €, £, ¥, ₹, CustomThe currency associated with this field. Can be "Custom" to use advanced options.
The currency symbol associated with this field.
0, 1, 2, 3The number of decimal places to report.
LeftNoSpace, LeftWithSpace, RightNoSpace, RightWithSpaceSpecifies the location of the CurrencySymbol relative to the value.
Edit a custom field
This function will edit an existing custom field. Only account administrators and owners can edit custom fields.
The Id of the custom field you'd like to edit
The name of the custom field
Whether a field is required. Checkbox and TextArea fields cannot be required.
Whether this field will display on active pipeline item badge.
Whether this field will display on closed pipeline item badge.
Whether this field will display on pipeline report.
Whether this field will use the International Format to display information. Only applies to Number fields.
The options for a dropdown or checkbox field. All other fields can skip this parameter. To delete an exisitng option, leave its OptionId out of the array.
To add a new option, add an object with an Option but no OptionId.
object with the following fields:An option to appear in a dropdown or checkbox list.
The option's unique ID .
For date fields only; indicates if the field should populate the calendar or not.
For date fields only; indicates if the date is one-time or if it repeats annually.
For date fields, the settings to customize the appearance of the field on the user's calendar.
object with the following fields:Text, Icon, IconTextIf ShowOnCalendar is set, indicates if the field should show as text, an icon, or both.
If Icon or IconText is set for Display, the name of the icon to use.
If Text or IconText is set for Display, the text to use. If nothing is set, will default to the name of the field.
For link fields, indicates if the field can support one or multiple contacts.
For field sections, the settings to customize the appearance of the section.
object with the following fields:The icon for the section.
The color for the section.
If the section should be collapsed by default.
For currency fields, the settings to customize the appearance of the field.
object with the following fields:$, €, £, ¥, ₹, CustomThe currency associated with this field. Can be "Custom" to use advanced options.
The currency symbol associated with this field.
0, 1, 2, 3The number of decimal places to report.
LeftNoSpace, LeftWithSpace, RightNoSpace, RightWithSpaceSpecifies the location of the CurrencySymbol relative to the value.
Delete a custom field
This function will delete an existing custom field. Only account administrators and owners can delete custom contact fields.
Get a custom field
This function will return a custom field on your account.
The ID for the custom field you'd like to get
List custom fields
This function will return a list of all the custom fields on your account.
Whether deleted custom fields should be included in the result.
Contact, Company, Pipeline, If you want fields for a specific record type, then you can set the record type here. If NULL, all custom fields will be returned.
If you are requesting pipeline fields, you can pass in a specific PipelineId for just one pipeline's custom fields.
If sections should be returned. Defaults to false.
How many results should be returned from a single API call? The max value is 10,000. If you need to return
more results, call this API function again, but increment the Page parameter.
If there are more results than MaxNumberOfResults, you can call this function again with an incremented
Page value to get the next page of results. For example, if there are 700 results, but you're only requesting
500 at a time, you could call this function with Page=2 to get the remaining 200 results.