Update all properties of a user Custom Field.
put
/learn.rest/v1/learnCenters/{learnCenterId}/userCustomFields/{userCustomFieldId}
Request
Supported Media Types
- application/json
Path Parameters
-
learnCenterId: number
Unique identifier of a LearnCenter.
-
userCustomFieldId: number
Unique identifier of a User Custom Field definition.
Custom field object that needs to be updated.
Root Schema : User Custom Fields
Type:
Show Source
object
-
defaultValue(optional):
string
Default Value:Example:
n/a
-
elementOptions(optional):
array elementOptions
-
elementShowSelectOne(optional):
boolean
Default Value:
false
Example:false
-
elementType:
string
Default Value:
textbox
Example:radio
-
name:
string
Example:
User Custom Field 1
- sharedFlag(optional): boolean
-
status(optional):
string
Default Value:
active
Allowed Values:[ "active", "inactive" ]
Example:active
Nested Schema : UserCustomFieldElementOptionsLink
Type:
Show Source
object
-
isDefault(optional):
boolean
Example:
false
-
value(optional):
string
Example:
first value
Security
-
auth: basic
Type:
basic
Description:Basic Authentication
Response
Supported Media Types
- application/xml
- application/json
200 Response
Resource updated.
400 Response
Request has incorrect syntax or does not contain a field that is required.
401 Response
404 Response
Resource not found.
500 Response
Internal server error.