Update workspace

PUT

/v2/workspaces

Update Workspace

This endpoint allows you to update an existing workspace.

Endpoint

Request Body

Name	Type	Description
`id`	`string`	The unique ID of the workspace to update.
`name`	`string`	The new name of the workspace.

Example Request

{
    "id": "f69cde69-ab43-4168-b78b-77a50a02b8dd",
    "name": "New Workspace"
}

Request

Header Params

x-auth-zapmail

string

required

Example:

Body Params application/json

object {0}

Example

{
    "id": "b9085239-6bb1-479b-8a30-271f7d6f904e",
    "name": "New Workspace"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.zapmail.ai/api/v2/workspaces' \
--header 'x-auth-zapmail: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "b9085239-6bb1-479b-8a30-271f7d6f904e",
    "name": "New Workspace"
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "status": 200,
    "message": "Workspace updated successfully",
    "data": {
        "id": "b9085239-6bb1-479b-8a30-271f7d6f904e",
        "userId": "fbf34af0-be3b-4add-bd97-462e2471f65d",
        "name": "New Workspace",
        "createdAt": "2024-08-09T06:08:47.459Z",
        "updatedAt": "2024-08-09T06:17:20.331Z",
        "deletedAt": null
    }
}

Modified at 2025-01-30 13:09:39

Create new workspace

Add Billing Details

Update workspace

Update Workspace#

Endpoint#

Request Body#