Skip to content
Proud to collaborate with Microsoft for Startups

chat.conversation.archive ​

Archive an existing chat conversation for a (organization, user) pair

Archive a chat conversation for a (organization, user) pair.

Inputs:

  • organization_uuid: UUID of the organization (required)
  • user_uuid: UUID of the user opening the chat (required, must be a member)
  • conversation_uuid: UUID of the conversation to archive (required)

Outputs:

  • conversation_uuid: ChatConversation.uuid
  • archived: true
  • title: resolved conversation title

Failure reasons:

  • organization_not_found_or_unauthorized
  • conversation_not_found
  • validation_failed
  • database_error

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-chat
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—UUID of the organization that owns the conversation
user_uuiduuidNo—UUID of the MEMBER that owns the conversation. Required for a member run; refused on an end-user run, where the owner is the server-resolved principal from the verified token
conversation_uuiduuidYes—UUID of the chat conversation to archive

Output Schema ​

FieldTypeRequiredDefaultDescription
conversation_uuiduuidYes—Archived ChatConversation.uuid
archivedbooleanYes—True when the conversation is archived
titlestringNo—Conversation title
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name
organization_uuiduuidNo——
user_uuiduuidNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "chat.conversation.archive",
  "initial_data": {
    "organization_uuid": "value",
    "conversation_uuid": "value"
  }
}