OMomni
Topics

Update topic

Changed on

Update an existing topic.

patch/v1/models/{modelId}/topic/{topicName}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/models/{modelId}/topic/{topicName}
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

modelIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

The ID of the model.

topicNamestring required
Example:sales_analytics

The name of the topic.

Query parameters

branch_idstring uuid
Example:123e4567-e89b-12d3-a456-426614174001

Branch ID to use for branch-aware operations. Accepts either the org-wide branch ID (an orgBranchId, also returned by the Branches API) or the ID of that branch's layer on this specific model.

Request body

descriptionstring

Description of the topic, shown in the topic picker

groupLabelstring

Group label for the topic

hiddenboolean

Whether the topic is hidden from the topic picker.

labelstring

The display label for the topic

newTopicNamestring

The new name of the topic, if performing a rename.

Example request

{
  "description": "Details about the Blobs R Us product roadmap",
  "groupLabel": "Product",
  "label": "Blob Roadmap",
  "newTopicName": "2026 Blob Roadmap"
}

Response

Topic updated successfully

successboolean

Example response

{
  "success": true
}

Changes