classifications

Update Classification

patch/v1/classifications/{application_id}/{classification_id}

Request

  • Base URL: https://api.branchly.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.branchly.io/v1/classifications/{application_id}/{classification_id}
  • Auth: HTTP bearer

Path parameters

classification_idstring uuid required
application_idstring uuid required

Request body

namestring nullable
descriptionstring nullable

Human-readable description of what this topic/intent means and when the AI should assign it.

localesobject nullable

Frontend display labels keyed by locale code.

status'active' | 'suggestion' | 'denied' | 'deleted'

Status of a classification definition.

Response

Successful Response

idstring uuid required
application_idstring uuid required
type'topic' | 'intent' required

Type of classification.

namestring required
descriptionstring nullable required
localesobject
status'active' | 'suggestion' | 'denied' | 'deleted' required

Status of a classification definition.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.