Create Bookmark REST Endpoint

POST api.ashx/v2/bookmark.{json|xml}

CREATE a bookmark.

Scopes

Bookmarks › Modify Bookmarks bookmarks.bookmarks.modify

Request Parameters

Name Type Location Description Required Default Options
ContentId Guid? Id of the content to bookmark. Either ContentUrl or Both ContentId and ContentTypeId are required. Optional
ContentTypeId Guid? Content type of the content to bookmark. Either ContentUrl or Both ContentId and ContentTypeId are required. Optional
ContentUrl string Either ContentUrl or Both ContentId and ContentTypeId are required. ContentUrl requires authentication using OAuth. Optional
TypeId Guid? Categorization type Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.post({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/bookmark.json'
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "Bookmark": {
    "Url": "url",
    "TypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
    "User": {
      "AvatarUrl": "avatarurl",
      "DisplayName": "displayname",
      "ProfileUrl": "profileurl",
      "Username": "username",
      "CurrentStatus": {
        "Author": {
          "AvatarUrl": "avatarurl",
          "DisplayName": "displayname",
          "ProfileUrl": "profileurl",
          "Username": "username",
          "CurrentStatus": {
            "Author": {
              "AvatarUrl": "avatarurl",
              "DisplayName": "displayname",
              "ProfileUrl": "profileurl",
              "Username": "username",
              "CurrentStatus": null,
              "Id": null
            },
            "Body": "body",
            "CreatedDate": "2012-01-04T00:00:00",
            "ReplyCount": 6,
            "Group": {
              "AvatarUrl": "avatarurl",
              "DateCreated": null,
              "Description": "description",
              "Key": "key",
              "Name": "name",
              "Url": "url",
              "TotalMembers": null,
              "HasGroups": true,
              "GroupCount": null,
              "GroupType": "grouptype",
              "EnableGroupMessages": true,
              "EnableContact": true,
              "SearchUniqueId": "searchuniqueid",
              "IsEnabled": true,
              "ExtendedAttributes": [],
              "ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
              "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
              "Container": null,
              "Id": null
            },
            "AttachedUrl": "attachedurl",
            "HasReplies": true,
            "ContentId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
            "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
            "Url": "url",
            "IsPublished": true,
            "Content": {
              "CreatedByUser": null,
              "ContentId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
              "ContentTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
              "CreatedDate": "2012-05-02T00:00:00",
              "HtmlName": "htmlname",
              "HtmlDescription": "htmldescription",
              "Url": "url",
              "AvatarUrl": "avatarurl",
              "Application": null
            },
            "Id": "e3715662-2528-4ba1-84a7-bfcd9d548f80"
          },
          "Id": 25
        },
        "Body": "body",
        "CreatedDate": "2012-06-04T00:00:00",
        "ReplyCount": 8,
        "Group": {
          "AvatarUrl": "avatarurl",
          "DateCreated": "2011-05-28T00:00:00",
          "Description": "description",
          "Key": "key",
          "Name": "name",
          "ParentGroupId": 4,
          "Url": "url",
          "TotalMembers": 7,
          "HasGroups": true,
          "GroupCount": 27,
          "GroupType": "grouptype",
          "EnableGroupMessages": true,
          "EnableContact": true,
          "SearchUniqueId": "searchuniqueid",
          "IsEnabled": true,
          "ExtendedAttributes": [
            {
              "Key": "key",
              "Value": "value"
            },
            {
              "Key": "key",
              "Value": "value"
            }
          ],
          "ContainerId": "6cdcf200-3bad-476d-af45-97b52545c337",
          "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
          "Container": {
            "ContainerId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
            "ContainerTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
            "HtmlName": "htmlname",
            "Url": "url",
            "AvatarUrl": "avatarurl"
          },
          "Id": 32
        },
        "AttachedUrl": "attachedurl",
        "HasReplies": true,
        "ContentId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
        "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
        "Url": "url",
        "IsPublished": true,
        "Content": {
          "CreatedByUser": {
            "AvatarUrl": "avatarurl",
            "DisplayName": "displayname",
            "ProfileUrl": "profileurl",
            "Username": "username",
            "CurrentStatus": {
              "Author": null,
              "Body": "body",
              "CreatedDate": null,
              "ReplyCount": 52,
              "Group": null,
              "AttachedUrl": "attachedurl",
              "HasReplies": null,
              "ContentId": "fe65240b-044c-4292-9946-f10e0361ecff",
              "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
              "Url": "url",
              "IsPublished": true,
              "Content": null,
              "Id": "fe65240b-044c-4292-9946-f10e0361ecff"
            },
            "Id": 19
          },
          "ContentId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
          "ContentTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
          "CreatedDate": "2011-12-09T00:00:00",
          "HtmlName": "htmlname",
          "HtmlDescription": "htmldescription",
          "Url": "url",
          "AvatarUrl": "avatarurl",
          "Application": {
            "ApplicationId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
            "ApplicationTypeId": "6cdcf200-3bad-476d-af45-97b52545c337",
            "HtmlName": "htmlname",
            "HtmlDescription": "htmldescription",
            "Url": "url",
            "AvatarUrl": "avatarurl",
            "Container": {
              "ContainerId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
              "ContainerTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
              "HtmlName": "htmlname",
              "Url": "url",
              "AvatarUrl": "avatarurl"
            }
          }
        },
        "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e"
      },
      "Id": 112
    },
    "CreatedDate": "2012-03-29T00:00:00",
    "Content": {
      "CreatedByUser": {
        "AvatarUrl": "avatarurl",
        "DisplayName": "displayname",
        "ProfileUrl": "profileurl",
        "Username": "username",
        "CurrentStatus": {
          "Author": {
            "AvatarUrl": "avatarurl",
            "DisplayName": "displayname",
            "ProfileUrl": "profileurl",
            "Username": "username",
            "CurrentStatus": {
              "Author": null,
              "Body": "body",
              "CreatedDate": null,
              "ReplyCount": 61,
              "Group": null,
              "AttachedUrl": "attachedurl",
              "HasReplies": null,
              "ContentId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
              "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
              "Url": "url",
              "IsPublished": true,
              "Content": null,
              "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46"
            },
            "Id": 18
          },
          "Body": "body",
          "CreatedDate": "2012-04-19T00:00:00",
          "ReplyCount": 76,
          "Group": {
            "AvatarUrl": "avatarurl",
            "DateCreated": "2012-01-16T00:00:00",
            "Description": "description",
            "Key": "key",
            "Name": "name",
            "ParentGroupId": 6,
            "Url": "url",
            "TotalMembers": 25,
            "HasGroups": true,
            "GroupCount": 8,
            "GroupType": "grouptype",
            "EnableGroupMessages": true,
            "EnableContact": true,
            "SearchUniqueId": "searchuniqueid",
            "IsEnabled": true,
            "ExtendedAttributes": [],
            "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
            "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
            "Container": {
              "ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
              "ContainerTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
              "HtmlName": "htmlname",
              "Url": "url",
              "AvatarUrl": "avatarurl"
            },
            "Id": 4
          },
          "AttachedUrl": "attachedurl",
          "HasReplies": true,
          "ContentId": "fe65240b-044c-4292-9946-f10e0361ecff",
          "ContentType": "56f1a3ec-14bb-45c6-949f-ee7776d68c78",
          "Url": "url",
          "IsPublished": true,
          "Content": {
            "CreatedByUser": {
              "AvatarUrl": "avatarurl",
              "DisplayName": "displayname",
              "ProfileUrl": "profileurl",
              "Username": "username",
              "CurrentStatus": null,
              "Id": null
            },
            "ContentId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
            "ContentTypeId": "44df201a-07e6-42eb-96c7-8ce7ce35aab6",
            "CreatedDate": "2012-01-04T00:00:00",
            "HtmlName": "htmlname",
            "HtmlDescription": "htmldescription",
            "Url": "url",
            "AvatarUrl": "avatarurl",
            "Application": {
              "ApplicationId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
              "ApplicationTypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
              "HtmlName": "htmlname",
              "HtmlDescription": "htmldescription",
              "Url": "url",
              "AvatarUrl": "avatarurl",
              "Container": null
            }
          },
          "Id": "fe65240b-044c-4292-9946-f10e0361ecff"
        },
        "Id": 7
      },
      "ContentId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
      "ContentTypeId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
      "CreatedDate": "2012-05-02T00:00:00",
      "HtmlName": "htmlname",
      "HtmlDescription": "htmldescription",
      "Url": "url",
      "AvatarUrl": "avatarurl",
      "Application": {
        "ApplicationId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
        "ApplicationTypeId": "e3715662-2528-4ba1-84a7-bfcd9d548f80",
        "HtmlName": "htmlname",
        "HtmlDescription": "htmldescription",
        "Url": "url",
        "AvatarUrl": "avatarurl",
        "Container": {
          "ContainerId": "6cdcf200-3bad-476d-af45-97b52545c337",
          "ContainerTypeId": "b04540ec-eb38-4fa1-b7bb-e3fde05401b4",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        }
      }
    }
  },
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <Bookmark>
    <Url>url</Url>
    <TypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</TypeId>
    <User>
      <Id>112</Id>
      <AvatarUrl>avatarurl</AvatarUrl>
      <DisplayName>displayname</DisplayName>
      <ProfileUrl>profileurl</ProfileUrl>
      <Username>username</Username>
      <CurrentStatus>
        <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
        <Author>
          <Id>25</Id>
          <AvatarUrl>avatarurl</AvatarUrl>
          <DisplayName>displayname</DisplayName>
          <ProfileUrl>profileurl</ProfileUrl>
          <Username>username</Username>
          <CurrentStatus>
            <Id>e3715662-2528-4ba1-84a7-bfcd9d548f80</Id>
            <Author>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DisplayName>displayname</DisplayName>
              <ProfileUrl>profileurl</ProfileUrl>
              <Username>username</Username>
            </Author>
            <Body>body</Body>
            <CreatedDate>2012-01-04T00:00:00</CreatedDate>
            <ReplyCount>6</ReplyCount>
            <Group>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DateCreated />
              <Description>description</Description>
              <Key>key</Key>
              <Name>name</Name>
              <Url>url</Url>
              <TotalMembers />
              <HasGroups>true</HasGroups>
              <GroupCount />
              <GroupType>grouptype</GroupType>
              <EnableGroupMessages>true</EnableGroupMessages>
              <EnableContact>true</EnableContact>
              <SearchUniqueId>searchuniqueid</SearchUniqueId>
              <ExtendedAttributes />
              <ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId>
            </Group>
            <AttachedUrl>attachedurl</AttachedUrl>
            <ContentId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContentId>
            <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
            <Url>url</Url>
            <IsPublished>true</IsPublished>
            <Content>
              <ContentId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentId>
              <ContentTypeId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentTypeId>
              <CreatedDate>2012-05-02T00:00:00</CreatedDate>
              <HtmlName>htmlname</HtmlName>
              <HtmlDescription>htmldescription</HtmlDescription>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Content>
          </CurrentStatus>
        </Author>
        <Body>body</Body>
        <CreatedDate>2012-06-04T00:00:00</CreatedDate>
        <ReplyCount>8</ReplyCount>
        <Group>
          <Id>32</Id>
          <AvatarUrl>avatarurl</AvatarUrl>
          <DateCreated>2011-05-28T00:00:00</DateCreated>
          <Description>description</Description>
          <Key>key</Key>
          <Name>name</Name>
          <ParentGroupId>4</ParentGroupId>
          <Url>url</Url>
          <TotalMembers>7</TotalMembers>
          <HasGroups>true</HasGroups>
          <GroupCount>27</GroupCount>
          <GroupType>grouptype</GroupType>
          <EnableGroupMessages>true</EnableGroupMessages>
          <EnableContact>true</EnableContact>
          <SearchUniqueId>searchuniqueid</SearchUniqueId>
          <ExtendedAttributes>
            <key>value</key>
            <key>value</key>
          </ExtendedAttributes>
          <ContainerId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerId>
          <Container>
            <ContainerId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerId>
            <ContainerTypeId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContainerTypeId>
            <HtmlName>htmlname</HtmlName>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
          </Container>
        </Group>
        <AttachedUrl>attachedurl</AttachedUrl>
        <ContentId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentId>
        <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
        <Url>url</Url>
        <IsPublished>true</IsPublished>
        <Content>
          <CreatedByUser>
            <Id>19</Id>
            <AvatarUrl>avatarurl</AvatarUrl>
            <DisplayName>displayname</DisplayName>
            <ProfileUrl>profileurl</ProfileUrl>
            <Username>username</Username>
            <CurrentStatus>
              <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id>
              <Body>body</Body>
              <CreatedDate />
              <ReplyCount>52</ReplyCount>
              <AttachedUrl>attachedurl</AttachedUrl>
              <ContentId>fe65240b-044c-4292-9946-f10e0361ecff</ContentId>
              <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
              <Url>url</Url>
              <IsPublished>true</IsPublished>
            </CurrentStatus>
          </CreatedByUser>
          <ContentId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentId>
          <ContentTypeId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentTypeId>
          <CreatedDate>2011-12-09T00:00:00</CreatedDate>
          <HtmlName>htmlname</HtmlName>
          <HtmlDescription>htmldescription</HtmlDescription>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
          <Application>
            <ApplicationId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ApplicationId>
            <ApplicationTypeId>6cdcf200-3bad-476d-af45-97b52545c337</ApplicationTypeId>
            <HtmlName>htmlname</HtmlName>
            <HtmlDescription>htmldescription</HtmlDescription>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
            <Container>
              <ContainerId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerId>
              <ContainerTypeId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContainerTypeId>
              <HtmlName>htmlname</HtmlName>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Container>
          </Application>
        </Content>
      </CurrentStatus>
    </User>
    <CreatedDate>2012-03-29T00:00:00</CreatedDate>
    <Content>
      <CreatedByUser>
        <Id>7</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DisplayName>displayname</DisplayName>
        <ProfileUrl>profileurl</ProfileUrl>
        <Username>username</Username>
        <CurrentStatus>
          <Id>fe65240b-044c-4292-9946-f10e0361ecff</Id>
          <Author>
            <Id>18</Id>
            <AvatarUrl>avatarurl</AvatarUrl>
            <DisplayName>displayname</DisplayName>
            <ProfileUrl>profileurl</ProfileUrl>
            <Username>username</Username>
            <CurrentStatus>
              <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id>
              <Body>body</Body>
              <CreatedDate />
              <ReplyCount>61</ReplyCount>
              <AttachedUrl>attachedurl</AttachedUrl>
              <ContentId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentId>
              <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
              <Url>url</Url>
              <IsPublished>true</IsPublished>
            </CurrentStatus>
          </Author>
          <Body>body</Body>
          <CreatedDate>2012-04-19T00:00:00</CreatedDate>
          <ReplyCount>76</ReplyCount>
          <Group>
            <Id>4</Id>
            <AvatarUrl>avatarurl</AvatarUrl>
            <DateCreated>2012-01-16T00:00:00</DateCreated>
            <Description>description</Description>
            <Key>key</Key>
            <Name>name</Name>
            <ParentGroupId>6</ParentGroupId>
            <Url>url</Url>
            <TotalMembers>25</TotalMembers>
            <HasGroups>true</HasGroups>
            <GroupCount>8</GroupCount>
            <GroupType>grouptype</GroupType>
            <EnableGroupMessages>true</EnableGroupMessages>
            <EnableContact>true</EnableContact>
            <SearchUniqueId>searchuniqueid</SearchUniqueId>
            <ExtendedAttributes />
            <ContainerId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerId>
            <Container>
              <ContainerId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId>
              <ContainerTypeId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerTypeId>
              <HtmlName>htmlname</HtmlName>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Container>
          </Group>
          <AttachedUrl>attachedurl</AttachedUrl>
          <ContentId>fe65240b-044c-4292-9946-f10e0361ecff</ContentId>
          <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
          <Url>url</Url>
          <IsPublished>true</IsPublished>
          <Content>
            <CreatedByUser>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DisplayName>displayname</DisplayName>
              <ProfileUrl>profileurl</ProfileUrl>
              <Username>username</Username>
            </CreatedByUser>
            <ContentId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContentId>
            <ContentTypeId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentTypeId>
            <CreatedDate>2012-01-04T00:00:00</CreatedDate>
            <HtmlName>htmlname</HtmlName>
            <HtmlDescription>htmldescription</HtmlDescription>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
            <Application>
              <ApplicationId>49fec544-6df7-4a82-872b-f8be586d5e9e</ApplicationId>
              <ApplicationTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ApplicationTypeId>
              <HtmlName>htmlname</HtmlName>
              <HtmlDescription>htmldescription</HtmlDescription>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Application>
          </Content>
        </CurrentStatus>
      </CreatedByUser>
      <ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId>
      <ContentTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentTypeId>
      <CreatedDate>2012-05-02T00:00:00</CreatedDate>
      <HtmlName>htmlname</HtmlName>
      <HtmlDescription>htmldescription</HtmlDescription>
      <Url>url</Url>
      <AvatarUrl>avatarurl</AvatarUrl>
      <Application>
        <ApplicationId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ApplicationId>
        <ApplicationTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ApplicationTypeId>
        <HtmlName>htmlname</HtmlName>
        <HtmlDescription>htmldescription</HtmlDescription>
        <Url>url</Url>
        <AvatarUrl>avatarurl</AvatarUrl>
        <Container>
          <ContainerId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerId>
          <ContainerTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Application>
    </Content>
  </Bookmark>
</Response>
Related
Recommended

About
Privacy Policy
Terms of use
Copyright 2024 Verint, Inc.
Powered by Verint Community