Loading ...

REST API: Update User & Multiple Users | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Update User & Multiple Users
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 40

REST API: Update User & Multiple Users

0 
 /5
0 (0votes)

Note This API call is limited to core user properties. To update a user with custom profile fields, use REST API: Update User Profile Fields .

Update User

PUT /api/users/{UserID}

Update a user specified by user ID. Only core user properties are supported. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
PUT
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
UserID Used in the request URL as a path parameter Unique identifier for a particular user.
User JSON Used in the request body This is JSON that represents a user object that you're updating. This should be of the format seen below in the sample given.
Optional Parameters How to use Description
Email Used in the request body Email ID of the user.
Password Used in the request body Used to validate the user.
UserName Used in the request body Used to validate the user.
Gender Used in the request body Accepted values: 1:none, 2:male, 3:female (only integer values accepted)
AIM Used in the request body User's AIM messenger ID.
Bio Used in the request body User's biography.
DateFormat Used in the request body User can choose between various date formats.
DOB Used in the request body User's date of birth.
EmailRecieve Used in the request body User can choose to receive email notifications from the website.
  • NoEmail = 0
  • OnlyExternalEmails = 1
  • NoExternalEmails = 2
  • AllEmails = 3
Note: Only integer values are accepted.
FacebookURL Used in the request body User's Facebook profile link.
FavoriteBooks Used in the request body User's favorite books.
FavoriteCuisines Used in the request body User's favorite cuisines.
FavoriteMusic Used in the request body User's favorite music.
FavoriteTVShows Used in the request body User's favorite tv shows.
FirstName Used in the request body User's first name.
GoogleIM Used in the request body User's Google messenger ID.
Interests Used in the request body User can share interests with the community.
IsContactInfoVisible Used in the request body If this is true, user's contact information is visible publicly.
IsOptInPromotionalEmails Used in the request body If this is true, user agrees to receive promotional emails from the website. 
IsProfilePublic Used in the request body If this is true, then user's profile is visible publicly otherwise it is private.
IP Used in the request body User's IP address.
LastName Used in the request body User's last name.
LinkedinURL Used in the request body User's Linkedin profile link.
MiddleName Used in the request body User's middle name.
MSN Used in the request body User's MSN messenger ID.
Occupation Used in the request body User's job title.
PhoneNumber Used in the request body Used to update users phone number.
FaxNumber Used in the request body Used to update users fax number.
Salutation Used in the request body User's salutation. Accepted values: Mr, Ms, Mrs, Dr.
SkypeIM Used in the request body User's Skype messenger ID.
CompanyName Used in the request body User's company name.
SpaceDigestOption Used in the request body
Option values are: 0, 1, 2, 3
0 = No Digest
1 = All Digests
2 = Daily Digest Only
3 = Weekly Digest Only
Note: Only integer values accepted.
isMultipleUsers Used in URL to indicate multiple users updated
true = multiple users are in the call
Update a Single User

PUT https://myintranet.communifire.com/api/users/1317

Body:

"{\"FirstName\":\"Seth\",\"LastName\":\"Lynch\"}"

Note: Stringify your JSON data.

Example Response

User ID is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"True",
    "ResponseData":1317
}

Update Multiple Users
You can update multiple users in one API command by using the isMultipleUsersRequest in the API call. Follow this format:
POST {{Domain}}/api/users/fields?isMultipleUsersRequest=true
Body:
"[{\"UserID\":\"377\",\"Company\":\"My Company\",\"Phone\":\"123456789\",\"Share my profile\":\"false\"},{\"UserID\":\"3166\",\"Company\":\"Foo Company\",\"Phone\":\"0123456789\",\"Share my profile\":\"true\"}]"

Response: 

[
    {
        "IsError": false,
        "ResponseMessage": "Success",
        "ResponseData": 377
    },
    {
        "IsError": false,
        "ResponseMessage": "Success",
        "ResponseData": 3166
    }
    
]

 

Please Note The content type that you pass in the header of your request should be application/json.

Wiki Index

Pages

Intranet Software