Skip to main content

Profile

This guide explains how to manage user profiles in the Calwe application.

Request

Show Profile

  • Method: GET
  • URL: /v1/customer/profile

Request Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Success Response

GET /v1/customer/profile
{
"success": true,
"message": "تم جلب البيانات بنجاح.",
"data": {
"id": "cde55d16-d2ec-4429-9b08-cc5ad8e7fbdb",
"firstName": "فاضل",
"lastName": "الفاخوري",
"email": "khalid@khalid.com",
"birthDate": "2024/01/09",
"phone": "966561497555",
"phoneCode": "+966",
"gender": "انثى",
"avatar": "https://i.ibb.co/YhTw0wR/7-512.png",
"country": {
"id": "fc068332-c09a-43bf-aa11-04f6e8d623b1",
"name": "السعودية",
"phoneCode": "+966",
"priority": null
},
"completeAccountPercentage": 100,
"nationality": {
"id": "f43fbf9b-03bd-4666-a689-68f84d10c665",
"phoneCode": "+691",
"name": "مايكرونيزيي"
},
"isEmailVerified": true,
"sessionTimer": null,
"sessionType": null,
"canBookFreeSession": true
},
"statusCode": 200
}

Update Profile

  • Method: POST
  • URL: /v1/customer/profile

Request Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Request Body

ParameterTypeDescriptionRequired
first_namestringUser's first nameNo
last_namestringUser's last nameNo
emailstringUser's email addressNo
old_passwordstringUser's old passwordNo
passwordstringUser's passwordNo
password_confirmationstringUser's password confirmationNo
phonestringUser's phoneNo
genderstringUser's genderNo
birth_datestringUser's birth dateNo
national_idstringUser's nationalNo
avatarstringUser's avatarNo
clear_avatarstringUser's clear avatarNo

Success Response

{
"success": true,
"message": "تم تحديث البيانات بنجاح.",
"data": {
"id": "uuid",
"firstName": "فاضل",
"lastName": "Saeed",
"email": "khalid@khalid.com",
"birthDate": "2024/01/09",
"phone": "966561497555",
"phoneCode": "+966",
"gender": "انثى",
"avatar": "https://i.ibb.co/YhTw0wR/7-512.png",
"country": {
"id": "uuid",
"name": "السعودية",
"phoneCode": "+966",
"priority": null
},
"completeAccountPercentage": 100,
"nationality": {
"id": "uuid",
"phoneCode": "+691",
"name": "مايكرونيزيي"
},
"isEmailVerified": true,
"sessionTimer": null,
"sessionType": null,
"canBookFreeSession": true
},
"statusCode": 200
}

Error Responses

Email Already Exists (422)

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

Invalid Email Format (422)

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

Send Verification Phone Code

  • Method: POST
  • URL: /v1/customer/profile/send-verification-phone-code

Request Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Request Body

ParameterTypeDescriptionRequired
phonestringUser's phoneYes

Success Response

{
"success": true,
"message": "تم ارسال رمز تفعيل الجوال مرة أخرى بنجاح.",
"data": [],
"statusCode": 200
}

Error Responses

Email Already Exists (422)

{
"message": "قيمة رقم الهاتف مُستخدمه من قبل.",
"errors": {
"phone": [
"قيمة رقم الهاتف مُستخدمه من قبل."
]
}
}

Verify Phone

  • Method: POST
  • URL: /v1/customer/profile/verify-phone

Request Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Request Body

ParameterTypeDescriptionRequired
phonestringUser's phoneYes
phone_verified_codestringUser's verified phone codeYes

Success Response

{
"success": true,
"message": "تم التحقق من رقم جوالك بنجاح",
"data": [
"777777777"
],
"statusCode": 200
}

Error Responses

Email Already Exists (422)

{
"success": false,
"message": "كود التفعيل غير صحيح",
"errors": [
"كود التفعيل غير صحيح"
],
"data": [],
"statusCode": 422
}