ClientSuccess Custom Fields

On the Global Settings > Fields Settings page, you will be able to create custom fields for the Customer, Contact, and Contract objects. At the top of the page, you will select which object you are wanting to view by selecting the named object. The following options are the different type of fields that you can create:

To create a field, click on the orange "New Field" option on the right side of the page. As you enter a name for the field, the key will automatically be added. The key will replace certain characters with an underscore and will append the name to include "__cs" at the end. At the time of creation, you can enter another key as desired (the key can not be changed once the field is created). Lastly select what type of field you would like to create and confirm.

For each field that is created, those will automatically display on the object that it was created for. For your Customer and Contact custom fields, you will be able to apply those custom fields to their corresponding grids and sort those fields as needed.
​
​

Custom Field Limit

By default your custom field limit is set to 20 per object. We set this limit as the default because we want you to determine what information brings the most value for the Customer. We want you to be mindful not to oversaturate the Customer record with data that may not bring value to that Customer. With that in mind, we can increase this limit for you at any time. If ever you are needing additional fields, please reach out to your CSM or support@clientsuccess.com and we will increase that limit for you.
​
​
​Custom Field Order

Your custom fields will display on your Customers, Contacts, and Contracts based on the order that they appear on the Global Settings > Field Settings page. To change the order your fields appear, you can click on the icon to the left of the custom field name and drag it to the desired location. As soon as the change is made, those fields will appear in that order on the Customer record.

Note: You may need to refresh the page for the changes to take effect, if multiple ClientSuccess windows are open.

Required Fields

By default, each object has at least one field that is required for creation. From the Global Settings > Field Settings page, you can determine if you would like to have additional fields required. Each object will list a couple of the native fields that are able to be made required. Any custom field that is created has the option of being required.

To make a field required, you will click on the required toggle next to the custom field. When enabled, a record (Customer, Contact, or Contract) can not be created or edited if the required field does not have a value. If you attempt to save the record and the required field does not have a value, you will see an error message appear stating that a required field does not have a value.

Note: For any required custom fields included in your CRM integration, those fields will be required to be added to the integration. If those required fields do not have a value coming from your external CRM, the record in ClientSuccess will fail to be created or updated as needed.
​
​

Placeholders

For any custom field you would like to have a placeholder in one to many emails, you will want to enable the toggle next to the custom field name. Once enabled, you will be able to apply the custom field value for the associated Customer in your outgoing emails.
​
​

CRM Integrations Picklist & Multi-Select Picklist fields

As you create options in ClientSuccess for these fields, the Api Key assigned to each option will auto create. Certain characters in these options will be replaced by underscore characters. At the time of creation for each option, you will be able to enter in a Custom API Key as needed. However once this field is created, the API Key for the option can not be edited.
​

When syncing values for picklist and multi-select picklist fields, we match on the API Keys assigned to each option. With this in mind, as part of the integration, we will auto create any new options we receive from your external CRM (based on the API Key). As a best practice, we recommend creating your Picklist fields and Multi-Select Picklist fields with a placeholder option (one option is required at time of creation). Then we can use the integration to create the rest of the options as needed.
​
​

Resetting and Deleting Custom Fields

If you would like to remove all values for a custom field, you can use the reset option. To use this option, you go to the Global Settings > Field Setting page click on the ellipsis (three dots) to the far right of the custom field. You can then select Reset and confirm to start processing. After confirmation, a back end process will run to remove any data for selected field. This process can take up to 15 minutes to finish processing.
​

To delete a custom field, you will first need to reset the custom field using the steps above. A custom field can not be deleted if it has any values or if it is tied to a SuccessScore profile, Automation Rule, or other feature in CS.
​

If you are attempting to reset or delete a custom field and are having troubles, please contact support@clientSuccess.com for further assistance.