API Guide v2.0

Create Bookmark

HTTP Method & URL
POST <base-url>?Type=Bookmark&Version=1
<query parameters>
Parameters
Type <required> Bookmark
Version <required> API version#
UserId <required> UserID of the user who is creating the bookmark
Url <required> URL of the bookmark
Title <required> Title of the bookmark
Tags <required> List of tags separated by commas
Description <optional> Description
CommunityType<optional> Should be one of the following values: 
  . company - Company group ("Share with All") *Default value
  . private - Private (Persoanl) group
  . group - Indicates Open or Restricted group ("Share with a group")
          - For group, the group id should be specified by the CommunityId
 parameter. Since this is an existing group, we can figure out if it is
  restricted or open group and there is no need to specify it explicitly.
CommunityId ID of the group to which you want to attach this bookmark.
Description
Creates a new bookmark.
Returns
HTTP Status Code: 201 (successfully created) or 400 (bad request)
HTTP Header: BookmarkId
Example Response
For a successful transaction, there is no XML response. For failed requests, the response is the standard XML error response as described in the API Summary section.

back to top

©2008 Connectbeam, Inc.