Move userfield to new category

Last modified on September 11, 2023 at 1:50 pm

Overview

You can move a userfield to a different category by updating its categoryId property. Note that this allows you to move a userfield from the private set of admin-only userfield categories into the public user-modifiable categories and vice-versa.

Note that you are not limited to updating one property at a time; all fields that are valid for a particular userfield type may be updated in a single request. All fields not specified will retain their value. See the Userfield Object Reference for a list of all the object’s fields.

Example

This example shows the request-response sequence when moving a custom userfield to a new category by updating its categoryId property.

Request
PUT /dc/api/v5/userfields/8da97a97a92efd18dcbc12876a4510e HTTP/1.1
Host: org.digitalchalk.com
Content-type: application/json
Accept: application/json

{
	"categoryName": "Example Category"
}
Response
HTTP/1.1 204 No Content

References