Documentation

API /user/{userId}/customfield/{customfieldgroup}/{customfieldname}/update

ThoughtFarmer REST API Method: /user/{userId}/customfield/{templateId}/update

Updates a custom field for a user. The templateId is the unique name of the custom field.
 
URL:
http://yourserver.com/api/user/{userId}/customfield/{customfieldgroup}/{customfieldname}/update

http://yourserver.com/api/2.0/user/{userId}/customfield/{customfieldgroup}/{customfieldname}/update


Response Formats:
xml,json

HTTP Method(s):
POST
 
Requires Authentication:
true, user making call must pass a valid token parameter

Parameters:

 Parameter Type Description
userId int Required. The user id of the user to retrieve
customfieldgroup string Required. The group name of the custom field to retreive the data for
customfieldname string Required. The name of the custom field. This is the sanitized name of the custom field. e.g. a filed called Start Date would be santized to StartDate.
value string Required. The value to update the custom field to
token string Required. A valid token authentication parameter
Response Status Codes:
200 - Success
401 - Token parameter is invalid
403 - You do not have permission to update this user or you are trying to update a private custom field that does not belong to you
500 - Any of: templateId is not valid; the group/field parts do not match an existing custom field; the value doesn't match an option in a dropdown custom field; value is too long; value is empty for a tag custom field; tag creation is disabled; custom field is not editable

Example request
POST http://yourserver.com/api/user/{userId}/customfield/{customfieldgroup}/{customfieldname}/update
POST Data value={value}&token={token}
e.g. https://yourserver.com/api/user/1234/customfield/expertiseskills/languages/update
{
   "CustomFieldId":25,
   "Editable":true,
   "Label":[
      {
         "Key":"en",
         "Value":"Technical Skills"
      }
   ],
   "Name":"TechnicalSkills",
   "Type":5,
   "Value":""
}