ContactUs

This guide explains how to interact with the admin manage the contact us crud.

Get ContactUs List

Endpoint

• Method: GET
• URL: /v1/admin/contact-us

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Query Parameters

Parameter	Type	Description	Required	Default
sort=created_at	string	ContactUs's created_at sort	No	null

Success Response

{
    "success": true,
    "message": "تم جلب بيانات المدرب بنجاح",
    "data": {
        "contactUs": [
            {
                "id": "uuid",
                "name": "name",
                "email": "example@gmail.com",
                "message": "message",
                "type": "مستشار",
                "status": "جديدة",
                "contactUsReason": {
                    "id": "uuid",
                    "reason": "أواجه مشكلة في الدفع و الشراء"
                },
                "hasAttachments": false
            },
        ]
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Show ContactUs

Endpoint

• Method: GET
• URL: /v1/admin/contact-us/{id}

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "id": "uuid",
        "name": "name",
        "email": "example@gmail.com",
        "message": "message",
        "type": "مستشار",
        "status": "جديدة",
        "problem": "لا يمكنني شراء باقة/جلسة",
        "contactUsReason": {
            "id": "uuid",
            "reason": "أواجه مشكلة في الدفع و الشراء"
        },
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Recored Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على السجل",
    "data": [],
    "statusCode": 404
}

Update ContactUs

Endpoint

• Method: PATCH
• URL: /v1/admin/contact-us/{id}

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
status	string	ContactUs's status	No

Success Response

{
    "success": true,
    "message": "تم تحديث البيانات بنجاح.",
    "data": {
        "id": "uuid",
        "name": "name",
        "email": "example@gmail.com",
        "message": "message",
        "type": "مستشار",
        "status": "جديدة",
        "problem": "لا يمكنني شراء باقة/جلسة",
        "contactUsReason": {
            "id": "uuid",
            "reason": "أواجه مشكلة في الدفع و الشراء"
        },
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Recored Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على السجل",
    "data": [],
    "statusCode": 404
}

Update ContactUs Index

Endpoint

• Method: PATCH
• URL: /v1/admin/contact-us

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Query Parameters

Parameter	Type	Description	Required	Default
ids	array	ContactUs's id	Yes	null
status	string	ContactUs's status	Yes	null

Success Response

{
    "success": true,
    "message": "تم تحديث البيانات بنجاح.",
    "data": [],
    "statusCode": 200
}

Error Response

Recored Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على السجل",
    "data": [],
    "statusCode": 404
}

Validation Error (422)

{
    "success": false,
    "message": "حدث خطأ في البيانات المرسلة يرجى التحقق منها.",
    "errors": {
        "status": "الحالة غير موجود."
    },
    "data": [],
    "statusCode": 422
}

ContactUs Download Attachments

Endpoint

• Method: PATCH
• URL: /v1/admin/contact-us/{id}/download

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Success Response

Download Attachments.zip

Error Response

Recored Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على السجل",
    "data": [],
    "statusCode": 404
}