OMomniapp
Models

Update topic

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

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/models/{modelId}/topic/{topicName}
  • Auth
    HTTP bearer

Path parameters

modelIdstring uuid required

Model UUID

Example:123e4567-e89b-12d3-a456-426614174000
topicNamestring required

Topic name

Example:sales_analytics

Query parameters

branch_idstring uuid

The branch to work in: its orgBranchId, or its per-model branch ID as listed under branches by GET /api/v1/models?include=activeBranches. 404 when the branch has no branch on this model.

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

Request body

descriptionstring

Topic description

groupLabelstring

Group label for the topic

hiddenboolean

Whether the topic is hidden

labelstring

Topic label

newTopicNamestring

New topic name (for rename)

Response

Topic updated successfully

successboolean required

Whether the operation was successful

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 97 revisions of this API.