Loading ...

REST API: Update Forum Topic | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Forums » REST API: Forum Topics (Discussions) » REST API: Update Forum Topic
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 37

REST API: Update Forum Topic

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

Supports the synchronization and modification of get content 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
ContentIDIntegerYESPathUnique identifier for a particular forum topic
Forum Topic JSONStringYESBodyThis is JSON that represents a forum topic object that you're updating. This should be of the format seen below in the sample given.

Optional Parameters

ParameterTypeRequiredLocationDescription
ContentTitleStringNOBodyTitle of the forum topic
ContentBodyStringNOBodyDescription of the forum topic
ParentContentIDIntegerNOBodyID of the forum under which the topic needs to be moved
SpaceIDIntegerNOBodyUnique ID of the space. Space ID should be 0 for Top Level Community.
AuthorIDIntegerNOBodyAuthor's unique ID. It can be used for ghostwriting purposes.
LockedByUserIDIntegerNOBodyUser ID of the user locking the forum topic
IsStickyBooleanNOBodySpecifies if the forum topic is sticky
IsFeaturedBooleanNOBodyUsed to mark a content as featured

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/content/23

Request Body

{}

Success Response

{
  "IsError": false,
  "ResponseMessage": "ToBePublished",
  "ResponseData": 23
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (contentID)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 forum topic was not found.Verify the forumTopicID 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