Create User Profile Field REST Endpoint

Ben Tiedt — Fri, 08 Mar 2024 17:49:40 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:49:40

POST api.ashx/v2/userprofilefields.{json|xml}

Request Parameters

Name	Type	Location	Description	Required
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	Required
IsSearchable	bool	Request Body	Include field in search, default is false	Optional
Title	string	Request Body	User profile field title	Required

Example Requests

Widget Javascript

jQuery.telligent.evolution.post({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/userprofilefields.json',
	data: { 
		'FieldTypeId': '6',
		'Title': 'title'
	}
}).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>