update Board
Developing
Testing Env
Testing Env
POST
/api/v1/boards/8
Last modified:2025-04-29 20:49:21
API Endpoint: Update Board
PUT /api/boards/{id}Description
Authentication
Authorization: Bearer {api_token}Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Validation Rules |
|---|---|---|---|---|
| id | integer | Yes | ID of the board | `required |
Body Parameters (JSON)
| Parameter | Type | Required | Description | Validation Rules |
|---|---|---|---|---|
| client_name_ar | string | No* | Arabic client name | `required_without:client_name_en |
| client_name_en | string | No* | English client name | `required_without:client_name_ar |
| project_name_ar | string | No* | Arabic project name | `required_without:project_name_en |
| project_name_en | string | No* | English project name | `required_without:project_name_ar |
| description | string | No | Project description | `nullable |
| project_type | string | Yes | Type of project | `required |
| workspace_id | integer | No | Workspace Id | `nullable |
| team_ids | array | No | Array of team member IDs | `nullable |
| team_ids.* | integer | - | Individual team member ID | `integer |
Headers
| Key | Value | Required |
|---|---|---|
| Content-Type | application/json | Yes |
| Accept | application/json | Yes |
| Accept-Language | en/ar | No |
| user-token | {{user_token}} | Yes |
| secure-business-key | {{secure_business_key}} | Yes |
Responses
Success (200 OK)
{
"status": "success",
"code": 200,
"data": {
"board": {
"id": 1,
"client_name": "Updated Client Name",
"project_name": "Updated Project Name",
"description": "Updated description",
"project_type": "kanban",
"team_ids": [1, 2, 3],
"business_id": 123,
"created_at": "2023-01-01T12:00:00.000000Z",
"updated_at": "2023-01-15T10:30:00.000000Z"
}
},
"message": "Board updated successfully"
}Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v1/boards/8' \
--header 'Accept: application/json' \
--header 'Accept-Language: en' \
--header 'user-token: ' \
--header 'secure-business-key: 4765066450c0bd66325.48403130' \
--form 'client_name_ar="اسم العميل"' \
--form 'client_name_en="Client Name"' \
--form 'project_name_ar="اسم المشروع"' \
--form 'project_name_en="Project Name"' \
--form 'description="Project details"' \
--form 'project_type="kanban"' \
--form 'workspace_id="4"' \
--form 'team_ids[]="1"' \
--form 'team_ids[]="2"' \
--form 'team_ids[]="3"'Response Response Example
{
"status_code": 200,
"code": 1020,
"hint": "Processed Successfully",
"success": true,
"data": {
"board": {
"id": 8,
"client_name": "تعديل اسم العميل",
"project_name": "تعديل اسم المشروع",
"description": "Project details edit",
"project_type": "gantt",
"team_ids": "1,5,7",
"business_id": 259,
"workspace_id": "4",
"created_at": "2025-04-27T20:35:21.000000Z",
"updated_at": "2025-04-29T20:49:47.000000Z"
},
"message": "تم تحديث اللوحة بنجاح"
}
}Request
Header Params
Accept
string
optional
Example:
application/json
Accept-Language
string
optional
Example:
en
user-token
string
optional
Example:
{{user_token}}
secure-business-key
string
optional
Example:
{{secure_business_key}}
Content-Type
string
optional
Example:
application/json
Body Params multipart/form-data
client_name_ar
string
optional
Example:
اسم العميل
client_name_en
string
optional
Example:
Client Name
project_name_ar
string
optional
Example:
اسم المشروع
project_name_en
string
optional
Example:
Project Name
description
string
optional
Example:
Project details
project_type
string
optional
Example:
kanban
workspace_id
integer
optional
Example:
4
team_ids[]
array[string]
optional
Example:
["1","2","3"]