Endpoint: users

/users/add

POST /api/v1/users/add.ext HTTP/1.1
Host: https://yoursite.vanillaforums.com

Insert a user.

Authentication: required

Parameters

Parameter Type Description
Name string Username
Email string Email address
Password string User’s password
Photo String Photo URL
ShowEmail boolean Allow others to see this email address?
Gender string m,f, or u for unspecified
Title string Freeform user title
Location string Freeform user location
Role multi smart id Role ID (corresponds to GDN_Role)
Rank smart id Rank ID (corresponds to GDN_Rank)

Notes

The Photo field submitted here is only able to take a remotely hosted URL, not a file upload. In order to upload an avatar to the service, use the users/photo

/users/edit

POST /api/v1/users/edit.ext HTTP/1.1
Host: https://yoursite.vanillaforums.com

Modify user information.

Authentication: required

Parameters

Parameter Type Description
User smart id Required. The user to edit
Name string Username
Email string Email address
ShowEmail boolean Allow others to see this email address?
Gender string m,f, or u for unspecified
Title string freeform user title
Location string Freeform user location
Role multi smart id Role ID (corresponds to GDN_Role)
Rank smart id Rank ID (corresponds to GDN_Rank)

/users/photo

POST /api/v1/users/photo.ext HTTP/1.1
Host: https://yoursite.vanillaforums.com

Upload a new avatar

Authentication: required

Parameters

Parameter Type Description
User smart id Required. The user to edit
Avatar string Uploaded file

Notes

The Picture field submitted here takes a file upload using the multipart /form-data Content-Type in the request headers. It does not support a string URL like users/edit#Photo

/users/discussions

GET /api/v1/users/discussions.ext HTTP/1.1
Host: https://yoursite.vanillaforums.com

Gets a list of discussions that the user posted.

Authentication: No

GET Parameters

Parameter Type Description
User smart id required. The user whose settings to retrieve or modify

/users/comments

GET /api/v1/users/comments.ext HTTP/1.1
Host: https://yoursite.vanillaforums.com

Gets a list of comments that a user posted.

Authentication: No

GET Parameters

Parameter Type Description
User smart id required. The user whose settings to retrieve or modify

/users/multi

GET /api/v1/users/multi.ext HTTP/1.1
HOST: https://yoursite.vanillaforums.com

Get multiple users’ information.

Authentication: required

Parameters

Parameter Type Description
User multi smart id Required. A list of user IDs

/users/notifications

GET /api/v1/users/notifications.ext HTTP/1.1
POST 
HOST: https://yoursite.vanillaforums.com

Get/Set user notification preferences.

Authentication: required

GET Parameters

Parameter Type Description
User smart id Required. The user whose settings to retrieve or modify. Required for setting and getting.

POST Parameters

Parameter Type Description
Email.Mention integer Email notify when user us mentioned
Popup.Mention integer Popup notify when user us mentioned
Email.Badge integer Email notify when user receives a badge
Popup.Badge integer Popup notify when user receives a badge
Email.WallComment integer Email notify when user receives a wall post
Popup.WallComment integer Popup notify when user receives a wall post
Email.ActivityComment integer Email notify when user receives wall comment reply
Popup.ActivityComment integer Popup notify when user receives wall comment reply
Email.ConversationMessage integer Email notify when user receives a private message
Popup.ConversationMessage integer Popup notify when user receives a private message
Email.DiscussionComment integer Email notify when user receives a topic reply
Popup.DiscussionComment integer Popup notify when user receives a topic reply
Email.BookmarkComment integer Email notify when user receives a reply to a bookmarked topic
Popup.BookmarkComment integer Popup notify when user receives a reply to a bookmarked topic
Email.BadgeRequest integer Email notify when a new badge is requested
Popup.BadgeRequest integer Popup notify when a new badge is requested
Email.Applicant integer Email notify when anyone applies for membership

/users/get

GET /api/v1/users/get.ext HTTP/1.1
HOST: https://yoursite.vanillaforums.com

Get user information.

Authentication: no, But Perspective will be that of a guest

Parameters

Parameter Type Description
User smart id Required. The user to retrieve.

/users/sso

GET /api/v1/users/sso.ext HTTP/1.1
POST
HOST: https://yoursite.vanillaforums.com

Gets/Sets single-sign-on (SSO) information for a user.

Authentication: yes

GET

Gets the SSO information for a single user.

Parameters

Parameter Type Description
User smart id Required. The user to get.

POST

Update the SSO information for a user.

Parameters

Parameter Type Description
ClientID string The client ID from your SSO provider
UniqueID string The ID that uniquely identifies the user on your system (not Vanilla)
Username/Email string Either the username or the email of the user in Vanilla
Password string The password of the user in Vanilla

/users/delete

POST /api/v1/users/delete.ext HTTP/1.1
HOST: https://yoursite.vanillaforums.com

Delete a user from the application.

Authentication: yes

Parameters

Parameter Type Description
User smart id Required. The user to retrieve
DeleteMethod string Required. The method of content deletion. This should be one of: keep the user’s content. wipe Replace the user’s content with a “this content has been deleted” type method, delete Delete the user’s content

Cloud Hosting

We believe that online communities should be intuitive, engaging and true to your brand. Vanilla allows you to create a customized community that rewards positive participation, automatically curates content and lets members drive moderation.

Learn More …