Update a user - Telligent Evolution 6.x Developer Documentation - Developer Space

EndpointPOST (Header: PUT)api.ashx/v2/users/{id}.xml (or .json)

EndpointPOST (Header: PUT)api.ashx/v2/users/{username}.xml (or .json)

RequestUserUpdateRequest

Id	Optional	Either Id or Username is required.
Username	Optional	Either Id or Username is required.
User	Optional	The submission of a complete user node is deprecated, will be removed and should not be used for new development. Instead supply user properties for the request properties (Bio, DisplayName, etc.).
OldPassword	Optional	Required if changing the password.
NewPassword	Optional	NewPassword
PrivateEmail	Optional	PrivateEmail
DisplayName	Optional	DisplayName
AllowSitePartnersToContact	Optional	AllowSitePartnersToContact
AllowSiteToContact	Optional	AllowSiteToContact
Bio	Optional	Bio
Birthday	Optional	Birthday
IsBirthdaySet	Optional	IsBirthdaySet
ConversationContactType	Optional	Types of users who can start conversations with you. Options are: None, FriendsOnly, AllUsers.
DateFormat	Optional	DateFormat
EditorType	Optional	EditorType
EnableCommentNotifications	Optional	EnableCommentNotifications
EnableConversationNotifications	Optional	EnableConversationNotifications
EnableDisplayInMemberList	Optional	EnableDisplayInMemberList
EnableDisplayName	Optional	EnableDisplayName
EnableEmoticons	Optional	EnableEmoticons
EnableFavoriteSharing	Optional	EnableFavoriteSharing
ReceiveEmails	Optional	ReceiveEmails
EnableHtmlEmail	Optional	EnableHtmlEmail
EnableTracking	Optional	EnableTracking
EnableUserSignatures	Optional	EnableUserSignatures
Gender	Optional	Gender
Language	Optional	Language
Location	Optional	Location
PostSortOrder	Optional	PostSortOrder
PublicEmail	Optional	PublicEmail
Signature	Optional	Signature
TimeZone	Optional	TimeZone
TimeZoneId	Optional	TimeZoneId
WebUrl	Optional	WebUrl
AccountStatus	Optional	AccountStatus
ProfileFields	Optional	ProfileFields
RssFeeds	Optional	A comma delimited list of RSS feeds
EnabledActivityMessageTypes	Optional	A comma delimited list of enabled activity message types

Example (C#)

var webClient = new WebClient();

// replace the "admin" and "Admin's API key" with your valid user and apikey!
// http://telligent.com/community/developers/w/wiki/how-to-generate-an-api-key.aspx
var adminKey = String.Format("{0}:{1}", "Admin's API Key", "admin");
var adminKeyBase64 = Convert.ToBase64String(Encoding.UTF8.GetBytes(adminKey));

webClient.Headers.Add("Rest-User-Token", adminKeyBase64);
webClient.Headers.Add("Rest-Method", "PUT");
webClient.Headers.Add("Content-Type", "application/x-www-form-urlencoded");

var postUrl = "http://mysite.com/api.ashx/v2/users.xml/2100"; // or .json
var data = "OldPassword=sample-data3247a&NewPassword=sample-data6539c";

webClient.UploadData(postUrl, "POST", Encoding.ASCII.GetBytes(data));

Example Response (XML)

<?xml version="1.0" encoding="utf-8"?>
<Response>
  <Info />
  <Warnings />
  <Errors />
  <User>
    <Id>2100</Id>
    <AllowSitePartnersToContact>false</AllowSitePartnersToContact>
    <AllowSiteToContact>false</AllowSiteToContact>
    <AvatarUrl>http://mysite.com/cfs-file.ashx/__key/communityserver-components-selectableavatars/03b2c875-fbfb-4d26-8000-ef001b9f4728/avatar.png</AvatarUrl>
    <Bio />
    <Birthday>2011-07-05T10:50:39</Birthday>
    <CurrentStatus>
      <Id>5cdeaa7d-cda1-4fd3-a847-c8a890448f45</Id>
      <Body>sample-17dd1data67465</Body>
      <CreatedDate>2011-07-08T11:41:05.397</CreatedDate>
      <ReplyCount>0</ReplyCount>
      <HasReplies>false</HasReplies>
    </CurrentStatus>
    <DateFormat>ddd, MMM d yyyy</DateFormat>
    <DisplayName>admin</DisplayName>
    <ConversationContactType>FriendsOnly</ConversationContactType>
    <EditorType>Enhanced</EditorType>
    <EnableCommentNotifications>true</EnableCommentNotifications>
    <EnableConversationNotifications>true</EnableConversationNotifications>
    <EnableDisplayInMemberList>false</EnableDisplayInMemberList>
    <EnableDisplayName>true</EnableDisplayName>
    <EnableEmoticons>true</EnableEmoticons>
    <EnableFavoriteSharing>true</EnableFavoriteSharing>
    <ReceiveEmails>true</ReceiveEmails>
    <EnableHtmlEmail>true</EnableHtmlEmail>
    <EnableTracking>true</EnableTracking>
    <EnableUserSignatures>true</EnableUserSignatures>
    <Gender>Male</Gender>
    <JoinDate>2011-01-17T05:00:58.077-05:00</JoinDate>
    <LastLoginDate>2011-07-08T10:02:09.453-04:00</LastLoginDate>
    <Language>en-US</Language>
    <Location>sample-datacc834</Location>
    <Points>1880</Points>
    <PostSortOrder>Ascending</PostSortOrder>
    <PrivateEmail>notset@localhost.com</PrivateEmail>
    <ProfileUrl>http://mysite.com/members/admin/default.aspx</ProfileUrl>
    <PublicEmail>sample-data1410c@email.com</PublicEmail>
    <Signature />
    <TimeZone>-5</TimeZone>
    <TimeZoneInfo>Eastern Standard Time;-300;(GMT-05:00) Eastern Time (US &amp; Canada);Eastern Standard Time;Eastern Daylight Time;[01:01:0001;12:31:2006;60;[0;02:00:00;4;1;0;];[0;02:00:00;10;5;0;];][01:01:2007;12:31:9999;60;[0;02:00:00;3;2;0;];[0;02:00:00;11;1;0;];];</TimeZoneInfo>
    <TimeZoneId>Eastern Standard Time</TimeZoneId>
    <Username>admin</Username>
    <WebUrl>sample-data77f92</WebUrl>
    <ProfileFields>
      <AOLIM />
      <Birthday>2011-07-05 10:50:39</Birthday>
      <Blog />
      <Checkbox_UnitTest />
      <Color_UnitTest />
      <CommaseparatedListContentAppending_UnitTest />
      <CommaseparatedList_UnitTest />
      <DateandTime_UnitTest />
      <Date_UnitTest />
      <Department />
      <Education>Big Time</Education>
      <Email />
      <Facebook />
      <Gallery />
      <Gender>Male</Gender>
      <GoogleIM />
      <Hobbies />
      <JanaTest />
      <Language>en-US</Language>
      <Location>sample-datacc834</Location>
      <Mobile />
      <Occupation />
      <Office />
      <OfficePhone />
      <PublicEmail>sample-data1410c@email.com</PublicEmail>
      <ThisIStheinternalfieldname />
      <Test7675 />
      <Time_UnitTest />
      <Title />
      <Twitter />
      <Url_UnitTest />
      <Website>sample-data77f92</Website>
      <WindowsLiveIM />
      <YahooIM />
    </ProfileFields>
    <AccountStatus>Approved</AccountStatus>
    <RssFeeds />
    <SearchUniqueId>Telligent.Evolution.Components.User, Telligent.Evolution.Components|2100</SearchUniqueId>
    <ExtendedAttributes>
      <EnableDisplayName>True</EnableDisplayName>
      <EditorType>Enhanced</EditorType>
      <EnableConversationNotifications>True</EnableConversationNotifications>
      <EnableCommentNotifications>True</EnableCommentNotifications>
      <enableCollapsingPanels>True</enableCollapsingPanels>
      <EnableUserSignatures>True</EnableUserSignatures>
      <CPPageSize>10</CPPageSize>
      <EnableActivityMessageNewUserAvatar>True</EnableActivityMessageNewUserAvatar>
      <EnableActivityMessageNewUserFile>False</EnableActivityMessageNewUserFile>
      <EnableActivityMessageNewUserFolder>False</EnableActivityMessageNewUserFolder>
      <EnableActivityMessageNewFriendship>True</EnableActivityMessageNewFriendship>
      <EnableActivityMessageNewBlog>True</EnableActivityMessageNewBlog>
      <EnableActivityMessageNewBlogPost>True</EnableActivityMessageNewBlogPost>
      <EnableActivityMessageNewBlogComment>True</EnableActivityMessageNewBlogComment>
      <EnableActivityMessageNewForum>True</EnableActivityMessageNewForum>
      <EnableActivityMessageNewForumThread>True</EnableActivityMessageNewForumThread>
      <EnableActivityMessageNewForumPost>True</EnableActivityMessageNewForumPost>
      <EnableActivityMessageNewMediaGallery>True</EnableActivityMessageNewMediaGallery>
      <EnableActivityMessageNewMediaGalleryPost>True</EnableActivityMessageNewMediaGalleryPost>
      <EnableActivityMessageNewMediaGalleryComment>True</EnableActivityMessageNewMediaGalleryComment>
      <EnableActivityMessageNewGroupMember>True</EnableActivityMessageNewGroupMember>
      <EnableActivityMessageNewWiki>True</EnableActivityMessageNewWiki>
      <EnableActivityMessageNewWikiPage>True</EnableActivityMessageNewWikiPage>
      <EnableActivityMessageUpdatedWikiPage>True</EnableActivityMessageUpdatedWikiPage>
      <EnableActivityMessageNewWikiPageComment>True</EnableActivityMessageNewWikiPageComment>
      <EnableActivityMessageThirdPartyMessageType>True</EnableActivityMessageThirdPartyMessageType>
      <EnableStartConversations>1</EnableStartConversations>
      <avatarUrl>~/cfs-file.ashx/__key/communityserver-components-selectableavatars/03b2c875-fbfb-4d26-8000-ef001b9f4728/avatar.png</avatarUrl>
      <EnableActivityMessageNewProfileComment>False</EnableActivityMessageNewProfileComment>
      <EnableActivityMessageNewUser>False</EnableActivityMessageNewUser>
      <EnableActivityMessageNewGroup>False</EnableActivityMessageNewGroup>
      <EnableActivityMessageStatus>True</EnableActivityMessageStatus>
    </ExtendedAttributes>
  </User>
</Response>

Example Response (JSON)

{
  "User": {
    "AllowSitePartnersToContact": false,
    "AllowSiteToContact": false,
    "AvatarUrl": "http://mysite.com/cfs-file.ashx/__key/communityserver-components-selectableavatars/03b2c875-fbfb-4d26-8000-ef001b9f4728/avatar.png",
    "Bio": "",
    "Birthday": "2011-07-05T10:50:39",
    "CurrentStatus": {
      "Author": null,
      "Body": "sample-17dd1data67465",
      "CreatedDate": "2011-07-08T11:41:05.397",
      "ReplyCount": 0,
      "Group": null,
      "HasReplies": false,
      "Id": "5cdeaa7d-cda1-4fd3-a847-c8a890448f45"
    },
    "DateFormat": "ddd, MMM d yyyy",
    "DisplayName": "admin",
    "ConversationContactType": "FriendsOnly",
    "EditorType": "Enhanced",
    "EnableCommentNotifications": true,
    "EnableConversationNotifications": true,
    "EnableDisplayInMemberList": false,
    "EnableDisplayName": true,
    "EnableEmoticons": true,
    "EnableFavoriteSharing": true,
    "ReceiveEmails": true,
    "EnableHtmlEmail": true,
    "EnableTracking": true,
    "EnableUserSignatures": true,
    "Gender": 1,
    "JoinDate": "2011-01-17T05:00:58.077-05:00",
    "LastLoginDate": "2011-07-08T10:02:09.453-04:00",
    "Language": "en-US",
    "Location": "sample-datacc834",
    "Points": 1880,
    "PostSortOrder": 0,
    "PrivateEmail": "notset@localhost.com",
    "ProfileUrl": "http://mysite.com/members/admin/default.aspx",
    "PublicEmail": "sample-data1410c@email.com",
    "Signature": "",
    "TimeZone": -5.0,
    "TimeZoneInfo": "Eastern Standard Time;-300;(GMT-05:00) Eastern Time (US & Canada);Eastern Standard Time;Eastern Daylight Time;[01:01:0001;12:31:2006;60;[0;02:00:00;4;1;0;];[0;02:00:00;10;5;0;];][01:01:2007;12:31:9999;60;[0;02:00:00;3;2;0;];[0;02:00:00;11;1;0;];];",
    "TimeZoneId": "Eastern Standard Time",
    "Username": "admin",
    "WebUrl": "sample-data77f92",
    "ProfileFields": [
      {
        "Label": "AOLIM",
        "Value": ""
      },
      {
        "Label": "Birthday",
        "Value": "2011-07-05 10:50:39"
      },
      {
        "Label": "Blog",
        "Value": ""
      },
      {
        "Label": "Checkbox_UnitTest",
        "Value": ""
      },
      {
        "Label": "Color_UnitTest",
        "Value": ""
      },
      {
        "Label": "CommaseparatedListContentAppending_UnitTest",
        "Value": ""
      },
      {
        "Label": "CommaseparatedList_UnitTest",
        "Value": ""
      },
      {
        "Label": "DateandTime_UnitTest",
        "Value": ""
      },
      {
        "Label": "Date_UnitTest",
        "Value": ""
      },
      {
        "Label": "Department",
        "Value": ""
      },
      {
        "Label": "Education",
        "Value": "Big Time"
      },
      {
        "Label": "Email",
        "Value": ""
      },
      {
        "Label": "Facebook",
        "Value": ""
      },
      {
        "Label": "Gallery",
        "Value": ""
      },
      {
        "Label": "Gender",
        "Value": "Male"
      },
      {
        "Label": "GoogleIM",
        "Value": ""
      },
      {
        "Label": "Hobbies",
        "Value": ""
      },
      {
        "Label": "JanaTest",
        "Value": ""
      },
      {
        "Label": "Language",
        "Value": "en-US"
      },
      {
        "Label": "Location",
        "Value": "sample-datacc834"
      },
      {
        "Label": "Mobile",
        "Value": ""
      },
      {
        "Label": "Occupation",
        "Value": ""
      },
      {
        "Label": "Office",
        "Value": ""
      },
      {
        "Label": "OfficePhone",
        "Value": ""
      },
      {
        "Label": "PublicEmail",
        "Value": "sample-data1410c@email.com"
      },
      {
        "Label": "ThisIStheinternalfieldname",
        "Value": ""
      },
      {
        "Label": "Test7675",
        "Value": ""
      },
      {
        "Label": "Time_UnitTest",
        "Value": ""
      },
      {
        "Label": "Title",
        "Value": ""
      },
      {
        "Label": "Twitter",
        "Value": ""
      },
      {
        "Label": "Url_UnitTest",
        "Value": ""
      },
      {
        "Label": "Website",
        "Value": "sample-data77f92"
      },
      {
        "Label": "WindowsLiveIM",
        "Value": ""
      },
      {
        "Label": "YahooIM",
        "Value": ""
      }
    ],
    "AccountStatus": "Approved",
    "RssFeeds": [],
    "SearchUniqueId": "Telligent.Evolution.Components.User, Telligent.Evolution.Components|2100",
    "ExtendedAttributes": [
      {
        "Key": "EnableDisplayName",
        "Value": "True"
      },
      {
        "Key": "EditorType",
        "Value": "Enhanced"
      },
      {
        "Key": "EnableConversationNotifications",
        "Value": "True"
      },
      {
        "Key": "EnableCommentNotifications",
        "Value": "True"
      },
      {
        "Key": "enableCollapsingPanels",
        "Value": "True"
      },
      {
        "Key": "EnableUserSignatures",
        "Value": "True"
      },
      {
        "Key": "CPPageSize",
        "Value": "10"
      },
      {
        "Key": "EnableActivityMessageNewUserAvatar",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewUserFile",
        "Value": "False"
      },
      {
        "Key": "EnableActivityMessageNewUserFolder",
        "Value": "False"
      },
      {
        "Key": "EnableActivityMessageNewFriendship",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewBlog",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewBlogPost",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewBlogComment",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewForum",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewForumThread",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewForumPost",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewMediaGallery",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewMediaGalleryPost",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewMediaGalleryComment",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewGroupMember",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewWiki",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewWikiPage",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageUpdatedWikiPage",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageNewWikiPageComment",
        "Value": "True"
      },
      {
        "Key": "EnableActivityMessageThirdPartyMessageType",
        "Value": "True"
      },
      {
        "Key": "EnableStartConversations",
        "Value": "1"
      },
      {
        "Key": "avatarUrl",
        "Value": "~/cfs-file.ashx/__key/communityserver-components-selectableavatars/03b2c875-fbfb-4d26-8000-ef001b9f4728/avatar.png"
      },
      {
        "Key": "EnableActivityMessageNewProfileComment",
        "Value": "False"
      },
      {
        "Key": "EnableActivityMessageNewUser",
        "Value": "False"
      },
      {
        "Key": "EnableActivityMessageNewGroup",
        "Value": "False"
      },
      {
        "Key": "EnableActivityMessageStatus",
        "Value": "True"
      }
    ],
    "Id": 2100
  },
  "Info": [],
  "Warnings": [],
  "Errors": []
}