General Settings
This guide explains how to interact with the admin manage the general settings crud.
Show General Settings
Endpoint
- Method: GET
- URL:
/v1/admin/settings/general-settings
Request Headers
| Header | Value | Required |
|---|---|---|
| Content-Type | application/json | Yes |
| Accept | application/json | Yes |
| Authorization | Bearer token | Yes |
Success Response
{
"success": true,
"message": "تم جلب البيانات بنجاح.",
"data": {
"websiteTitle": "calwe",
"companyName": "sumaya",
"cgp": "#9Tgs!otyn"
},
"statusCode": 200
}
Error Response
Unauthorized (401)
{
"success": false,
"message": "يجب عليك تسجيل الدخول",
"data": [],
"statusCode": 401
}
Update General Settings
Endpoint
- Method: PATCH
- URL:
/v1/admin/settings/general-settings
Request Headers
| Header | Value | Required |
|---|---|---|
| Content-Type | application/json | Yes |
| Accept | application/json | Yes |
| Authorization | Bearer token | Yes |
Request Body
| Parameter | Type | Description | Required |
|---|---|---|---|
| website_title | string | Setting's website title | Yes |
| company_name | string | Setting's company name | Yes |
Success Response
{
"success": true,
"message": "تم حفظ البيانات بنجاح.",
"data": {
"websiteTitle": "calwe calwe",
"companyName": "zubair",
"cgp": "#9Tgs!otyn"
},
"statusCode": 200
}
Error Response
Unauthorized (401)
{
"success": false,
"message": "يجب عليك تسجيل الدخول",
"data": [],
"statusCode": 401
}
Clear Cache
Endpoint
- Method: PATCH
- URL:
/v1/admin/settings/settings/clear-response-cache
Request Headers
| Header | Value | Required |
|---|---|---|
| Content-Type | application/json | Yes |
| Accept | application/json | Yes |
| Authorization | Bearer token | Yes |
Success Response
{
"success": true,
"message": "تم حذف البيانات بنجاح.",
"data": [],
"statusCode": 200
}