Create custom fields

Creating custom fields is a straightforward method to enhance Connecteam's functionality by allowing you to define and capture specific data points that are important for your organization.

This process typically involves navigating to the settings or customization area within the platform, selecting the option to add a new custom field, and specifying the field type and details, such as text, dropdown, or date.

Once set up, these fields can help to personalize and streamline data management and employee records, ensuring that all necessary information aligns with your business requirements.

In Connecteam there are 2 types of custom fields: Dropdown and Regular.

Let's begin by examining the more intricate parameters involved when crafting a POST request for both types of custom fields:

• isRequired: Indicates whether the custom field is required, meaning every user in Connecteam’s system must have a value for this field. This parameter ensures that the field is not left empty and mandates input when adding or editing user information.
• isVisibleToAllAdmins: Indicates whether the custom field is visible to all admins. if this value is set to false - the viewAccessAdminIds field must be specified.
• viewAccessAdminIds: As mentioned above, this field must be specified (at least with one userId with Admin permissions) if the isVisibleToAllAdmins is set to false.
• isVisibleToUsers: Indicates whether the custom field is visible to users.
• isEditableForUsers: Indicates whether the custom field is editable by users.
  Applicable only to custom fields that are visible to users.

For the dropdown custom field type, you need to provide the following fields:

type: The type of the custom field should be: Dropdown.
dropdownOptions: A list of options available for selection in the dropdown field.

For the regular custom field type, you need to specify the type of the field from the following options:

• email/date/number/text/phone number/file/direct manager

Payload example for creating simple custom field request with specified admin IDs

"customFields": [
    {
      "name": "test",
      "categoryId": 123342,
      "isVisibleToAllAdmins": false,
      "viewAccessAdminIds": [ //Admins that can view this custom field. Applicable when isVisibleToAllAdmins is set to false
        123123,
        3422342,
        123144
      ],
      "isEditableForAllAdmins": false, 
      "editAccessAdminIds": [ //Admins that  can access and edit this custom field. Applicable when isEditableForAllAdmins is set to false.
        324234
      ],
      "type": "str",
      "isEditableForUsers": false,
      "isVisibleToUsers": true
    }
  ]

Payload example for creating dropdown type custom field request

 "customFields": [
    {
      "name": "test dropdown",
      "categoryId": 124332,
      "isVisibleToAllAdmins": true,
      "isEditableForAllAdmins": true,
      "dropdownOptions": [
        {
          "value": "option 1"
        },
        {
          "value": "option 2"
        },
        {
          "value": "option 3"
        }
      ],
      "type": "dropdown",
      "isMultiSelect": true,
      "isEditableForUsers": true,
      "isVisibleToUsers": true,
      "isRequired": true
    }
  ]