Less Annoying CRM logo Less Annoying CRM LACRM
Settings Functions

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.

How to call this function
Function name
CreateCustomField
Parameters
Name Text Required

The name of the custom field

RecordType Enum Default: Contact
Valid options: Contact, Company, Pipeline

The type of record this field is associated with.

Type Enum Required
Valid options: Dropdown, Checkbox, Number, Date, Text, TextArea, ContactLink, FileLink, Currency, Section

The type of field you'd like to create.

PipelineId Uid Default: NULL

If this is a pipeline field, the id of the pipeline this field is attached to.

IsRequired Bool Default: false

Whether a field is required. Checkbox and TextArea fields cannot be required.

IsTitle Bool Default: false

Whether this field will become the display name of a pipeline.

UsesInternationalFormat Bool Default: false

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.

ShowOnCalendar Bool Default: false

For date fields only; indicates if the field should populate the calendar or not.

AnnualDate Bool Default: false

For date fields only; indicates if the date is one-time or if it repeats annually.

DateDisplaySettings Array of objects

For date fields, the settings to customize the appearance of the field on the user's calendar.

Each item in the array should be an object with the following fields:
Display Enum Required
Valid options: Text, Icon, IconText

If ShowOnCalendar is set, indicates if the field should show as text, an icon, or both.

Icon Text Required

If Icon or IconText is set for Display, the name of the icon to use.

Label Text Required

If Text or IconText is set for Display, the text to use. If nothing is set, will default to the name of the field.

IsSingleLink Bool

For link fields, indicates if the field can support one or multiple contacts.

SectionDisplaySettings Array of objects

For field sections, the settings to customize the appearance of the section.

Each item in the array should be an object with the following fields:
Icon Text Default: Gear

The icon for the section.

Color Text Default: Blue

The color for the section.

IsCollapsedByDefault Bool Default: false

If the section should be collapsed by default.

CurrencyDisplaySettings Array of objects

For currency fields, the settings to customize the appearance of the field.

Each item in the array should be an object with the following fields:
CurrencyType Enum Required
Valid options: $, , £, ¥, , Custom

The currency associated with this field. Can be "Custom" to use advanced options.

CurrencySymbol Text Required

The currency symbol associated with this field.

NumberOfDecimalPlaces Enum Required
Valid options: 0, 1, 2, 3

The number of decimal places to report.

SymbolPlacement Enum Required
Valid options: LeftNoSpace, LeftWithSpace, RightNoSpace, RightWithSpace

Specifies the location of the CurrencySymbol relative to the value.

Response
{
"CustomFieldId": "3862528860392031304469583190691"
}

Edit a custom field

This function will edit an existing custom field. Only account administrators and owners can edit custom fields.

How to call this function
Function name
EditCustomField
Parameters
CustomFieldId Uid Required

The Id of the custom field you'd like to edit

Name Text

The name of the custom field

IsRequired Bool

Whether a field is required. Checkbox and TextArea fields cannot be required.

IsTitle Bool

Whether this field will become the display name of a pipeline.

UsesInternationalFormat Bool

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.

Each item in the array should be an object with the following fields:
Option Text Required

An option to appear in a dropdown or checkbox list.

OptionId Uid

The option's unique ID .

ShowOnCalendar Bool

For date fields only; indicates if the field should populate the calendar or not.

AnnualDate Bool

For date fields only; indicates if the date is one-time or if it repeats annually.

DateDisplaySettings Array of objects

For date fields, the settings to customize the appearance of the field on the user's calendar.

Each item in the array should be an object with the following fields:
Display Enum Required
Valid options: Text, Icon, IconText

If ShowOnCalendar is set, indicates if the field should show as text, an icon, or both.

Icon Text Required

If Icon or IconText is set for Display, the name of the icon to use.

Label Text Required

If Text or IconText is set for Display, the text to use. If nothing is set, will default to the name of the field.

IsSingleLink Bool

For link fields, indicates if the field can support one or multiple contacts.

SectionDisplaySettings Array of objects

For field sections, the settings to customize the appearance of the section.

Each item in the array should be an object with the following fields:
Icon Text Default: Gear

The icon for the section.

Color Text Default: Blue

The color for the section.

IsCollapsedByDefault Bool Default: false

If the section should be collapsed by default.

CurrencyDisplaySettings Array of objects

For currency fields, the settings to customize the appearance of the field.

Each item in the array should be an object with the following fields:
CurrencyType Enum Required
Valid options: $, , £, ¥, , Custom

The currency associated with this field. Can be "Custom" to use advanced options.

CurrencySymbol Text Required

The currency symbol associated with this field.

NumberOfDecimalPlaces Enum Required
Valid options: 0, 1, 2, 3

The number of decimal places to report.

SymbolPlacement Enum Required
Valid options: LeftNoSpace, LeftWithSpace, RightNoSpace, RightWithSpace

Specifies the location of the CurrencySymbol relative to the value.

Response
This function doesn't return anything. If there's no error message returned, that means the call was completed successfully.

Delete a custom field

This function will delete an existing custom field. Only account administrators and owners can delete custom contact fields.

How to call this function
Function name
DeleteCustomField
Parameters
CustomFieldId Uid

The ID for the custom field you'd like to delete

SectionDeletesFields Bool

For Sections only, if the fields inside this section should be deleted too.

Response
This function doesn't return anything. If there's no error message returned, that means the call was completed successfully.

Get a custom field

This function will return a custom field on your account.

How to call this function
Function name
GetCustomField
Parameters
CustomFieldId Uid Required

The ID for the custom field you'd like to get

Response
{
"CustomFieldId": "3862528860396642990488010976321",
"Name": "",
"RecordType": "",
"IsDefaultField": false,
"DateArchived": "2023-01-30T10:54:32-08:00",
"Type": "",
"IsRequired": false,
"IsMultiField": false,
"CompanyAutoComplete": false,
"SectionId": "3862528860396642990488011310841",
"SectionDisplaySettings": [
{
"Icon": "",
"Color": "",
"IsCollapsedByDefault": false
},
{...},
{...}
]
"FormColumn": 10,
"Options": [
{
"Option": "",
"OptionId": "3862528860396642990488012093703"
},
{...},
{...}
]
"UsesInternationalFormat": false,
"IsTitle": false,
"PipelineId": "3862528860396642990488011615197",
"ShowOnCalendar": false,
"DateDisplaySettings": [
{
"Display": "",
"Icon": "",
"Label": ""
},
{...},
{...}
]
"AnnualDate": false,
"IsSingleLink": false,
"CurrencyDisplaySettings": [
{
"CurrencyType": "",
"CurrencySymbol": "",
"NumberOfDecimalPlaces": 10,
"SymbolPlacement": ""
},
{...},
{...}
]
"MultiFieldType": [
{
"Value": "",
"TypeId": "3862528860396642990488011988114"
},
{...},
{...}
]
}

Get all custom fields

This function will return a list of all the custom fields on your account.

How to call this function
Function name
GetCustomFields
Parameters
IncludeArchivedFields Bool Default: false

Whether deleted custom fields should be included in the result.

RecordType Enum Default: NULL
Valid options: 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.

PipelineId Uid Default: NULL

If you are requesting pipeline fields, you can pass in a specific PipelineId for just one pipeline's custom fields.

IncludeSections Bool Default: false

If sections should be returned. Defaults to false.

MaxNumberOfResults Number Default: 500

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.

Page Number Default: 1

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.

Response
{
"HasMoreResults": false,
"Results": [
{
"CustomFieldId": "3862528860398948833497225704058",
"Name": "",
"RecordType": "",
"IsDefaultField": false,
"DateArchived": "2023-01-30T10:54:32-08:00",
"Type": "",
"IsRequired": false,
"IsMultiField": false,
"CompanyAutoComplete": false,
"SectionId": "3862528860401254676506439044081",
"SectionDisplaySettings": [
{
"Icon": "",
"Color": "",
"IsCollapsedByDefault": false
},
{...},
{...}
]
"FormColumn": 10,
"Options": [
{
"Option": "",
"OptionId": "3862528860401254676506438691920"
},
{...},
{...}
]
"UsesInternationalFormat": false,
"IsTitle": false,
"PipelineId": "3862528860401254676506439328898",
"ShowOnCalendar": false,
"DateDisplaySettings": [
{
"Display": "",
"Icon": "",
"Label": ""
},
{...},
{...}
]
"AnnualDate": false,
"IsSingleLink": false,
"CurrencyDisplaySettings": [
{
"CurrencyType": "",
"CurrencySymbol": "",
"NumberOfDecimalPlaces": 10,
"SymbolPlacement": ""
},
{...},
{...}
]
"MultiFieldType": [
{
"Value": "",
"TypeId": "3862528860401254676506439734636"
},
{...},
{...}
]
},
{...},
{...}
]
}
Next page: Groups