POST (Header:PUT) api.ashx/v2/userprofilefields/{name}.{json|xml}
Request Parameters
| Name | Type | Location | Description | Required | Default | Options |
|---|---|---|---|---|---|---|
| FieldTypeChoices | string | Request Body | User profile field type choices. Required for multiple select type fields. Use the format of _FieldTypeChoices_VALUE = LABEL where VALUE is the saved value and LABEL is the display name. The Order they are sent in is maintained. | Optional | ||
| FieldTypeId | int | Request Body | User profile field type id | Optional | ||
| IsSearchable | bool | Request Body | Include field in search, default is false | Optional | ||
| Name | string | Request Body | User profile field name | Required | ||
| Title | string | Request Body | User profile field title | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.put({
url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/userprofilefields/{name}.json',
data: {
'name': 'name'
}
}).then(function(response) {
// use response
});Example Responses
JSON
{
"UserProfileField": {
"Name": "name",
"Title": "title",
"RawTitle": "rawtitle",
"IsSearchable": true,
"FieldType": {
"Id": 6,
"Name": "name",
"IsSearchable": true,
"IsMultipleChoice": true
},
"FieldTypeChoices": [
{
"Label": "label",
"Value": "value"
},
{
"Label": "label",
"Value": "value"
}
]
},
"Errors": [
"string",
"string"
]
}XML
<?xml version="1.0" encoding="utf-16"?>
<Response>
<UserProfileField>
<Name>name</Name>
<Title>title</Title>
<RawTitle>rawtitle</RawTitle>
<IsSearchable>true</IsSearchable>
<FieldType>
<Id>6</Id>
<Name>name</Name>
<IsSearchable>true</IsSearchable>
<IsMultipleChoice>true</IsMultipleChoice>
</FieldType>
<FieldTypeChoices>
<label>value</label>
<label>value</label>
</FieldTypeChoices>
</UserProfileField>
<Errors>
<Message>string</Message>
<Message>string</Message>
</Errors>
</Response>