Edit Topic

Overview

  • This API allows users to edit a topic.
  • Topic to be edited is identified by the topic ID, which must be provided in the request body.
  • Topic is modified only in the language provided in request body.

Permissions

  • The user must have 'Edit' action on 'Topic' resource.
  • The user sending the request should be from the same or shared department as the topic.

Preconditions

  • At least one optional attributes must be provided
  • Last modified date timestamp provided in the request body must the match the last modified date of the given topic on the server.
SecurityoAuthUser
Request
Request Body schema: application/json
id
required
integer (id)
required
object (DateAndTime)
name
string (name) [ 1 .. 255 ] characters
required
object (language)
description
string (description) [ 0 .. 255 ] characters
object (articleForTopicHomeContent)
imageUrl
string (imageUrl)
isTranslatable
boolean (isTranslatable)
object (CustomAttributes)
Responses
204

No content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

409

Conflict

412

Preconditions failed

500

Internal server error

put/topics
Request samples
application/json
{
  • "id": 202200000003102,
  • "name": "Updated Name",
  • "lastModified": {
    },
  • "language": {
    }
}
Response samples
application/json
{
  • "code": "400-101",
  • "developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}