Update User Profile Field Group REST Endpoint

POST (Header:PUT) api.ashx/v2/userprofilefieldgroups/{id}.{json|xml}

Scopes

Users › Modify Profile Field Groups users.profilefieldgroups.modify

Request Parameters

Name	Type	Location	Description	Required
Id	int	Request Body	User profile field group id	Required
Title	string	Request Body	User profile field group title	Optional
UserProfileFieldNames	string	Request Body	Comma separated list of user profile field names	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.put({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/userprofilefieldgroups/{id}.json',
	data: { 
		'id': '6'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "UserProfileFieldGroup": {
    "Title": "title",
    "Id": 6,
    "RawTitle": "rawtitle",
    "UserProfileFields": [
      {
        "Name": "name",
        "Title": "title",
        "RawTitle": "rawtitle",
        "IsSearchable": true,
        "FieldType": {
          "Id": 25,
          "Name": "name",
          "IsSearchable": true,
          "IsMultipleChoice": true
        },
        "FieldTypeChoices": [
          {
            "Label": "label",
            "Value": "value"
          },
          {
            "Label": "label",
            "Value": "value"
          }
        ]
      },
      {
        "Name": "name",
        "Title": "title",
        "RawTitle": "rawtitle",
        "IsSearchable": true,
        "FieldType": {
          "Id": 8,
          "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>
  <UserProfileFieldGroup>
    <Title>title</Title>
    <Id>6</Id>
    <RawTitle>rawtitle</RawTitle>
    <UserProfileFields>
      <RestUserProfileField>
        <Name>name</Name>
        <Title>title</Title>
        <RawTitle>rawtitle</RawTitle>
        <IsSearchable>true</IsSearchable>
        <FieldType>
          <Id>25</Id>
          <Name>name</Name>
          <IsSearchable>true</IsSearchable>
          <IsMultipleChoice>true</IsMultipleChoice>
        </FieldType>
        <FieldTypeChoices>
          <label>value</label>
          <label>value</label>
        </FieldTypeChoices>
      </RestUserProfileField>
      <RestUserProfileField>
        <Name>name</Name>
        <Title>title</Title>
        <RawTitle>rawtitle</RawTitle>
        <IsSearchable>true</IsSearchable>
        <FieldType>
          <Id>8</Id>
          <Name>name</Name>
          <IsSearchable>true</IsSearchable>
          <IsMultipleChoice>true</IsMultipleChoice>
        </FieldType>
        <FieldTypeChoices>
          <label>value</label>
          <label>value</label>
        </FieldTypeChoices>
      </RestUserProfileField>
    </UserProfileFields>
  </UserProfileFieldGroup>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>

Recommended