Example Userfield Category Object

Below is an example of a JSON representation of a Userfield Category object. This illustrates how userfield categories are represented in server responses, and you can use this same format when creating or modifying userfield categories.

{
  "id": "982314a9c2eda8ffb27742090a400213",
  "type": "public",
  "name": "Alternate Contact Info",
  "orderIndex": 0,
  "createdDate": "2009-09-07T06:50:42Z"
}

Property Details

Property JSON Data Type Description
id string The userfield category’s unique identifier value. A userfield category’s URL in the API is composed of /dc/api/v5/userfieldcategories/ followed by this identifier.
type string Either public or private. A value of public indicates that this category is visible to end users; private means the category can only be seen by administrators. All userfields contained within the category inherit this behavior — any userfield contained in a public category becomes a user-visible userfield, and any userfield in a private userfield category becomes an administrator-only userfield.
name string The name of the userfield category. This will be visible to the user as a title across the top of the set of fields contained in this userfield group.
orderIndex number Controls the positioning of this userfield category in the overall user information form. The index of the first item is 0, lower numbers appear first.
createdDate string A date string representing the timestamp when the userfield category was initially created. For further information on the expected format, see the Date/Time Format documentation.