Manage a topic

Topic admin: add writers/readers (notified by email), remove members, switch visibility, rename, change description, archive/reactivate, delete a document.

patch/api/v1/topics/{ref}

Request

  • Base URL: https://myagentda.com
  • URL: https://myagentda.com/api/v1/topics/{ref}
  • Auth: API key in header Authorization

Path parameters

refstring required

Topic reference: number (T-3), unique name, or UUID.

Request body

add_writersstring[]

Grant read + write.

add_readersstring[]

Grant read-only.

remove_membersstring[]

Revoke access.

visibility'private' | 'workspace'

New visibility.

renamestring

New topic name.

descriptionstring nullable

New description (null clears it).

archiveboolean

true = archive (read-only), false = reactivate.

delete_documentstring

Document ID to delete (admin only).

Response

Applied changes.

appliedstring[]

Changes applied.

skippedstring[]

No-ops that were skipped.

Changes

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