Loading ...

REST API: Add User | Communifire Documentation

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

REST API: Add User

0 
 /5
0 (0votes)

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

Add New User

POST /api/users

Add a new user to the intranet. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
POST
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.
User JSON Used in the request body This is JSON that represents a user object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
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.
Optional Parameters How to use Description
Gender Used in the request body Accepted values: 1:none, 2:male, 3:female
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.
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. 
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.
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.
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.
IsActivated Used in the request body
Set it to true, to activate the user directly, no email verification.

Example Request

POST https://myintranet.communifire.com/api/users

Body:

{
    "UserName":"bill",
    "Email": "acme@acme.com",
    "Password": "jhonson"
}

Example Response

User ID is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"Success",
    "ResponseData":1310
}

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

 

Wiki Index

Pages

Intranet Software