update Workspace
Developing
Testing Env
Testing Env
POST
/api/v1/workspaces/update/8
Last modified:2025-04-29 08:21:30
Update Workspace
Endpoint
PUT /api/workspaces/{id}Parameters
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | integer | Yes | ID of the workspace |
Request Headers
| Key | Value | Required |
|---|---|---|
| Accept | application/json | Yes |
| user-token | {{user_token}} | Yes |
| secure-business-key | {{secure_business_key}} | Yes |
| Accept-Language | en/ar | No |
| Content-Type | string | Yes |
Request Body (JSON)
| Name | Type | Required | Description | Validation Rules |
|---|---|---|---|---|
| name_ar | string | Yes | Updated Arabic name | max:255 |
| name_en | string | Yes | Updated English name | max:255 |
| client_name | string | No | Updated client name | nullable, max:255 |
| description | string | No | Updated description | nullable, max:255 |
| board_ids | array | No | Updated array of board IDs | nullable, array, IDs must exist |
| team_ids | array | No | Updated array of team IDs | nullable, array, min:1 |
| business_id | integer | Yes | ID of the associated business | required |
Responses
Success Response (200 OK)
{
"status_code": 200,
"code": 1020,
"hint": "Processed Successfully",
"success": true,
"data": {
"workspace": {
"id": 8,
"name": "Workspace Name edit",
"client_name": "client name edit",
"description": "description edit",
"board_ids": "3,4",
"team_ids": "3,4",
"business_id": 259,
"created_at": "2025-04-29T07:44:40.000000Z",
"updated_at": "2025-04-29T08:20:32.000000Z"
},
"message": "Workspace updated successfully"
}
}Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/workspaces/update/8' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--header 'user-token: ' \
--header 'secure-business-key: 4765066450c0bd66325.48403130' \
--form 'name_ar="تعديل الاسم"' \
--form 'name_en="Workspace Name edit"' \
--form 'client_name="client name edit"' \
--form 'description="description edit"' \
--form 'board_ids[]="3"' \
--form 'board_ids[]="4"' \
--form 'team_ids[]="3"' \
--form 'team_ids[]="4"'Response Response Example
{
"status_code": 200,
"code": 1020,
"hint": "Processed Successfully",
"success": true,
"data": {
"workspace": {
"id": 8,
"name": "Workspace Name edit",
"client_name": "client name edit",
"description": "description edit",
"board_ids": "3,4",
"team_ids": "3,4",
"business_id": 259,
"created_at": "2025-04-29T07:44:40.000000Z",
"updated_at": "2025-04-29T08:20:32.000000Z"
},
"message": "Workspace updated successfully"
}
}Request
Header Params
Accept
string
optional
Example:
application/json
Accept-Language
string
optional
Example:
en
Content-Type
string
optional
Example:
application/json
user-token
string
optional
Example:
{{user_token}}
secure-business-key
string
optional
Example:
{{secure_business_key}}
Body Params multipart/form-data
name_ar
string
optional
Example:
تعديل الاسم
name_en
string
optional
Example:
Workspace Name edit
client_name
string
optional
Example:
client name edit
description
string
optional
Example:
description edit
board_ids[]
array[string]
optional
Example:
["3","4"]
team_ids[]
array[string]
optional
Example:
["3","4"]