Update userfield options

Overview

To update the options on a userfield, you can send an HTTP PUT request to the userfield URL with a JSON object containing an options property with the updated value. The options property consists of an array of objects with a string name property. The name property must be provided for every option.

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 updating the options property on a userfield. This will replace the current set of options with three options.

Request

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

{
	"options": [
		{ "name": "Option 1" },
		{ "name": "Option 2" },
		{ "name": "Option 3" }
	]
}

Response

HTTP/1.1 204 No Content

References

• Userfield Object Reference
• Userfield Types
• Constraints