Athena
Home
Environments
Environments
  • Development Server
  • Production
Home
Environments
Environments
  • Development Server
  • Production
  1. Workspace
  • Getting Started
    • Start Guide
  • Installation & Setup
    • Windows
  • Architecture
  • Guide
    • Bundles
      • Backend
    • Permissions
      • Frontend
    • Developers
      • Commit Lint
      • RESTful API
    • Workflows
      • Workflow Variables
  • API Reference
    • Authentication
      • Sign In
      • Logout
    • User
      • Get Authenticated User using Multiplai App Access Token
      • Get Authenticated User using Basic Token
    • Workspace
      • Get Workspaces Metrics
        GET
      • Get Workspaces
        GET
      • Update a Workspace
        PUT
      • Retrieve a workspace
        GET
      • Delete a Workspace
        DELETE
    • Provider
      • Get Providers
      • Retrieve a Provider
      • Update a Provider
      • Create a Provider
      • Delete a Provider
    • Account
      • Get Accounts
      • Update an Account
      • Create an Account
      • Delete an Account
      • Retrieve an Account
    • Agent
      • Get Agents
      • Update an Agent
      • Create an Agent
      • Delete an Agent
      • Retrieve an Agent
      • Run an Agent
      • Train an Agent
      • Generate an Agent
      • Share Agent
      • Get Agent Leaderboard
    • Workflow
      • Get Workflows
      • Create a Workflow
      • Retrieve a Workflow
      • Update a Workflow
      • Delete a Workflow
      • Trigger a webhook
      • Share Workflow
      • Generate Workflow
    • Workflow Execution
      • Get Workflow Executions
      • Get Workflow Execution Counts
      • Retrieve a Workflow Execution
      • Delete a Workflow Execution
    • Prompt
      • Get Prompts
      • Create a Prompt
      • Retrieve a Prompt
      • Update a Prompt
      • Delete a Prompt
      • Run a prompt
    • Memory
      • Get Memories
      • Retrieve a Memory
      • Update a Memory
      • Delete a Memory
    • Thread
      • Get Threads
      • Retrieve a Thread
      • Update a Thread
      • Delete a Thread
      • Create a Thread
      • Run a Thread
      • Generate Thread Name
    • Message
      • Get Messages
      • Retrieve a Message
      • Update a Message
      • Delete a Message
      • Create a Message
    • Large Language Model
      • Get Large Language Models
      • Retrieve a Large Language Model
    • Command Room Task
      • Store Command Room Task
      • Remove Command Room Task
    • Metrics
      • Get Agents Metrics
      • Get Workflows Metrics
      • Get Threads Metrics
      • Get Messages Metrics
      • Get Workflow Executions Metrics
  • Schemas
    • Resources
      • User
      • Workspace
      • Provider
      • Account
      • Agent
      • Workflow
      • Share
      • WorkflowExecution
      • WorkflowExecutionData
      • Prompt
      • Memory
      • Thread
      • Attachment
      • Media
      • Tool
      • Message
      • LargeLanguageModel
      • AgentLeaderboard
    • Utils
      • Pagination
        • PaginationMeta
        • PaginationLinks
      • Provider
        • AuthenticationConfig
      • Profile
        • ProfilePhotoConfig
      • Workflow
        • WorkflowExecutionDataWorkflowData
        • Node
        • Edge
  1. Workspace

Update a Workspace

Local
https://localhost
Local
https://localhost
PUT
/api/v1/workspaces/{workspace_uuid}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://localhost/api/v1/workspaces/' \
--header 'Accept: application/json' \
--header 'X-Multiplai-Authorization;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "with": "string",
    "is_onboarded": true,
    "metadata": {
        "onboarding_step": 0,
        "sources": [
            "string"
        ],
        "affiliate_name": "string",
        "role": "string",
        "industry": "string",
        "tools": [
            "string"
        ],
        "ai_tools": {
            "agents": [
                {
                    "emoji": "string",
                    "name": "string",
                    "description": "string"
                }
            ],
            "prompts": [
                {
                    "emoji": "string",
                    "name": "string",
                    "description": "string"
                }
            ],
            "workflows": [
                {
                    "emoji": "string",
                    "name": "string",
                    "description": "string"
                }
            ]
        }
    }
}'
Response Response Example
{
    "data": {
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "slug": "my-ai-workspace",
        "name": "My AI Workspace",
        "profile_photo_url": "https://example.com/storage/workspaces/workspace-123.jpg",
        "multiplai_id": "multiplai_workspace_abc123",
        "is_onboarded": true,
        "metadata": {
            "onboarding_step": 75,
            "sources": [
                "google_search",
                "social_media",
                "referral"
            ],
            "affiliate_name": "John Doe Marketing",
            "role": "Product Manager",
            "industry": "Technology",
            "tools": [
                "slack",
                "notion",
                "github"
            ],
            "ai_tools": {
                "agents": [
                    {
                        "emoji": "🤖",
                        "name": "Customer Support Bot",
                        "description": "Handles customer inquiries and support tickets"
                    }
                ],
                "prompts": [
                    {
                        "emoji": "✍️",
                        "name": "Email Writer",
                        "description": "Generates professional email responses"
                    }
                ],
                "workflows": [
                    {
                        "emoji": "⚡",
                        "name": "Lead Processing",
                        "description": "Automatically processes and qualifies incoming leads"
                    }
                ]
            },
            "property1": "string",
            "property2": "string"
        },
        "is_owner": true,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T14:45:00Z",
        "user": {
            "id": 123,
            "name": "John Doe",
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@example.com",
            "profile_photo_url": "https://example.com/storage/photos/user-123.jpg",
            "multiplai_id": "multiplai_abc123def456",
            "created_at": "2024-01-15T10:30:00Z",
            "updated_at": "2024-01-15T14:45:00Z",
            "primary_workspace": {}
        }
    }
}
Modified at 2025-06-20 03:43:55
Previous
Get Workspaces
Next
Retrieve a workspace
Built with