Update User Info API

Update User Info API

Path Parameters

user_id string required

user id

Query Parameters

client_auth_token string required

Client API token

Header Parameters

access-token string required
user access token
Example: jQ58plo1xWMEZHpyJTG_lQ
client string required
client access token
Example: mxlN0z0BStZEPwsvKI4YZg
expiry string required
timestamp of token expiry
Example: 1537177070
token-type string required
access token type
Example: Bearer
uid string required
user uid
Example: user@quranreflect.com

application/json

Request Body

user object
first_name string
description string
password string
password_confirmation string
default_lang string
iso code of user language
onesignal_player_id string
last_name string

Responses

• 200
• 422
• 500

---

OK

Response Headers

application/json

Schema

Example (from schema)

Example 1

Example

---

Schema

status string
data object
first_name string
last_name string
description string
default_lang string
onesignal_player_id string
email string
username string
id integer
uid string
name string
verified boolean
follow_notification boolean
comments_notification boolean
provider string
post_as boolean
android_registration_id null
sign_up_type string
emails_disabled boolean
is_admin? boolean
user_avatar_url string
rooms_list string[]
user_type null
message string

{
  "status": "string",
  "data": {
    "first_name": "string",
    "last_name": "string",
    "description": "string",
    "default_lang": "string",
    "onesignal_player_id": "string",
    "email": "string",
    "username": "string",
    "id": 0,
    "uid": "string",
    "name": "string",
    "verified": true,
    "follow_notification": true,
    "comments_notification": true,
    "provider": "string",
    "post_as": true,
    "sign_up_type": "string",
    "emails_disabled": true,
    "is_admin?": true,
    "user_avatar_url": "string",
    "rooms_list": [
      "string"
    ]
  },
  "message": "string"
}

{
  "status": "success",
  "data": {
    "first_name": "amer",
    "last_name": "abbas",
    "description": "test description",
    "default_lang": "ar",
    "onesignal_player_id": "",
    "email": "naveedahmada036@gmail.com",
    "username": "naveed",
    "id": 1885,
    "uid": "naveedahmada036@gmail.com",
    "name": "Amer Abbas",
    "verified": false,
    "follow_notification": false,
    "comments_notification": true,
    "provider": "email",
    "post_as": false,
    "android_registration_id": null,
    "sign_up_type": "OLD USER",
    "emails_disabled": true,
    "is_admin?": true,
    "user_avatar_url": ":s3_path_url/?1668674182",
    "rooms_list": [
      [
        250,
        "My Room"
      ],
      [
        264,
        "My Private Group"
      ],
      [
        272,
        "Testing Room"
      ]
    ],
    "user_type": null
  },
  "message": "Your profile has been updated successfully."
}

{
  "success": false,
  "errors": [
    "User not found."
  ],
  "status": "error"
}

Unprocessable Entity

Response Headers

• Cache-Control string
• Content-Type string
• Transfer-Encoding string
• X-Content-Type-Options string
• X-Frame-Options string
• X-Request-Id string
• X-XSS-Protection string

application/json

Schema

Example (from schema)

Example

---

Schema

object

{}

{
  "status": "error",
  "errors": [
    "Password confirmation doesn't match Password"
  ]
}

Internal Server Error

PUT /v1/users/:user_id

Request

Base URL

https://quranreflect.com

user_id — path required

client_auth_token — query required

access-token — header required

client — header required

expiry — header required

token-type — header required

uid — header required

Body

Default

Example 1

---

{
  "user": {
    "first_name": "string",
    "description": "string",
    "password": "string",
    "password_confirmation": "string",
    "default_lang": "string",
    "onesignal_player_id": "string",
    "last_name": "string"
  }
}

curl / cURL

curl -L -X PUT 'https://quranreflect.com/v1/users/:user_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "first_name": "string",
    "description": "string",
    "password": "string",
    "password_confirmation": "string",
    "default_lang": "string",
    "onesignal_player_id": "string",
    "last_name": "string"
  }
}'

python / requests

curl -L -X PUT 'https://quranreflect.com/v1/users/:user_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "first_name": "string",
    "description": "string",
    "password": "string",
    "password_confirmation": "string",
    "default_lang": "string",
    "onesignal_player_id": "string",
    "last_name": "string"
  }
}'

go / native

curl -L -X PUT 'https://quranreflect.com/v1/users/:user_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "first_name": "string",
    "description": "string",
    "password": "string",
    "password_confirmation": "string",
    "default_lang": "string",
    "onesignal_player_id": "string",
    "last_name": "string"
  }
}'

nodejs / axios

curl -L -X PUT 'https://quranreflect.com/v1/users/:user_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "first_name": "string",
    "description": "string",
    "password": "string",
    "password_confirmation": "string",
    "default_lang": "string",
    "onesignal_player_id": "string",
    "last_name": "string"
  }
}'

ruby / Net::HTTP

curl -L -X PUT 'https://quranreflect.com/v1/users/:user_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "first_name": "string",
    "description": "string",
    "password": "string",
    "password_confirmation": "string",
    "default_lang": "string",
    "onesignal_player_id": "string",
    "last_name": "string"
  }
}'

csharp / RestSharp

curl -L -X PUT 'https://quranreflect.com/v1/users/:user_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "first_name": "string",
    "description": "string",
    "password": "string",
    "password_confirmation": "string",
    "default_lang": "string",
    "onesignal_player_id": "string",
    "last_name": "string"
  }
}'

php / cURL

curl -L -X PUT 'https://quranreflect.com/v1/users/:user_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "first_name": "string",
    "description": "string",
    "password": "string",
    "password_confirmation": "string",
    "default_lang": "string",
    "onesignal_player_id": "string",
    "last_name": "string"
  }
}'

java / OkHttp

curl -L -X PUT 'https://quranreflect.com/v1/users/:user_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "first_name": "string",
    "description": "string",
    "password": "string",
    "password_confirmation": "string",
    "default_lang": "string",
    "onesignal_player_id": "string",
    "last_name": "string"
  }
}'

powershell / RestMethod

curl -L -X PUT 'https://quranreflect.com/v1/users/:user_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "user": {
    "first_name": "string",
    "description": "string",
    "password": "string",
    "password_confirmation": "string",
    "default_lang": "string",
    "onesignal_player_id": "string",
    "last_name": "string"
  }
}'