Loading ...

REST API: Update Bookmark | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Bookmarks » REST API: Update Bookmark
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 23

REST API: Update Bookmark

0 
 /5
0 (0votes)
Open API Guide
PUT/api/content/{contentID}/bookmarks

Supports the synchronization and modification of update bookmark properties via the API.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
TitleStringYESBodyDisplay name for the bookmark shown in the user's bookmarks list.
DescriptionStringYESBodyOptional note or context saved with the bookmark for future reference.
EntityTypeStringYESQueryREST API: System Entity Types Refers to the entity type id of the content

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/content/170/bookmarks?entitytype=3

Request Body

{
  "Title": "Axero API Documentation",
  "Description": "Official API reference for integrating with the Axero platform."
}

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "BookmarkID": 22,
    "EntityID": 170,
    "EntityType": 3,
    "SpaceID": 0,
    "Url": "https://your-site.com/articles/news/170/Blogging",
    "UserID": 21,
    "DateCreated": "2026-04-26T07:17:28.02",
    "SortOrder": 0,
    "Title": "Article on blogging",
    "Description": "Article on blogging",
    "IsExternal": false,
    "BookmarkEntityIconCssClass": "icon-file"
  }
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required field missing",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (contentID, entityType, stringifiedBookmark)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
404 Not FoundThe specified bookmark was not found.Verify the contentID is correct.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages