Update User - QuickBlox

Recipes

Update user password

1. Use a `user` parameter to set a new password

curl -X PUT\
-H "Content-Type: application/json" \
-H "QB-Token: 7483d80bb9caddd504764d85b050c85755aecc84" \
-d '{  
  "user":{
    "old_password":"myoldpassword!" \
    "password":"mynewpassword!"
  }
}' \
https://api.quickblox.com/users/96831397.json

2. Set an old password

Use an old_password parameter to set an old password.

curl -X PUT\
-H "Content-Type: application/json" \
-H "QB-Token: 7483d80bb9caddd504764d85b050c85755aecc84" \
-d '{  
  "user":{
    "old_password":"myoldpassword!" \
    "password":"mynewpassword!"
  }
}' \
https://api.quickblox.com/users/96831397.json

3. Set a new password

Use a password parameter to set a new password.

curl -X PUT\
-H "Content-Type: application/json" \
-H "QB-Token: 7483d80bb9caddd504764d85b050c85755aecc84" \
-d '{  
  "user":{
    "old_password":"myoldpassword!" \
    "password":"mynewpassword!"
  }
}' \
https://api.quickblox.com/users/96831397.json

4. As a result, the API returns a user with an updated password.

curl -X PUT\
-H "Content-Type: application/json" \
-H "QB-Token: 7483d80bb9caddd504764d85b050c85755aecc84" \
-d '{  
  "user":{
    "old_password":"myoldpassword!" \
    "password":"mynewpassword!"
  }
}' \
https://api.quickblox.com/users/96831397.json

Update user

1. Use a `user` parameter to update a user

curl -X PUT \
-H "Content-Type: application/json" \
-H "QB-Token: 7483d80bb9caddd504764d85b050c85755aecc84" \
-d '{  
  "user":{  
    "login":"Jen_Lesser",
    "email":"[email protected]",
    "external_user_id":"1433712",
    "facebook_id":"125553",
    "full_name":"Jen Lesser",
    "phone":"+965234215",
    "website":"https://jen.com",
    "tag_list":"android,web",
    "custom_data":"Head of marketing"
  }
}' \
https://api.quickblox.com/users/96831397.json

2. Set new values for the fields

You can update any field of the user.

curl -X PUT \
-H "Content-Type: application/json" \
-H "QB-Token: 7483d80bb9caddd504764d85b050c85755aecc84" \
-d '{  
  "user":{  
    "login":"Jen_Lesser",
    "email":"[email protected]",
    "external_user_id":"1433712",
    "facebook_id":"125553",
    "full_name":"Jen Lesser",
    "phone":"+965234215",
    "website":"https://jen.com",
    "tag_list":"android,web",
    "custom_data":"Head of marketing"
  }
}' \
https://api.quickblox.com/users/96831397.json

3. As a result, the API returns a user with the specified updated fields.

curl -X PUT \
-H "Content-Type: application/json" \
-H "QB-Token: 7483d80bb9caddd504764d85b050c85755aecc84" \
-d '{  
  "user":{  
    "login":"Jen_Lesser",
    "email":"[email protected]",
    "external_user_id":"1433712",
    "facebook_id":"125553",
    "full_name":"Jen Lesser",
    "phone":"+965234215",
    "website":"https://jen.com",
    "tag_list":"android,web",
    "custom_data":"Head of marketing"
  }
}' \
https://api.quickblox.com/users/96831397.json

Update user with API key

1. Use 'Authorization' header to pass API key

curl -X PUT\
-H "Content-Type: application/json" \
-H 'Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI' \
-d '{  
  "user":{
    "login":"Jen_Lesser",
    "email":"[email protected]",
    "external_user_id":"1433712",
    "facebook_id":"125553",
    "full_name":"Jen Lesser",
    "phone":"+965234215",
    "website":"https://jen.com",
    "tag_list":"android,web",
    "custom_data":"Head of marketing"
  }
}' \
https://api.quickblox.com/users/96831397.json

2. Use a `user` parameter to update a user

curl -X PUT\
-H "Content-Type: application/json" \
-H 'Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI' \
-d '{  
  "user":{
    "login":"Jen_Lesser",
    "email":"[email protected]",
    "external_user_id":"1433712",
    "facebook_id":"125553",
    "full_name":"Jen Lesser",
    "phone":"+965234215",
    "website":"https://jen.com",
    "tag_list":"android,web",
    "custom_data":"Head of marketing"
  }
}' \
https://api.quickblox.com/users/96831397.json

3. Set new values for the fields

You can update any field of the user.

curl -X PUT\
-H "Content-Type: application/json" \
-H 'Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI' \
-d '{  
  "user":{
    "login":"Jen_Lesser",
    "email":"[email protected]",
    "external_user_id":"1433712",
    "facebook_id":"125553",
    "full_name":"Jen Lesser",
    "phone":"+965234215",
    "website":"https://jen.com",
    "tag_list":"android,web",
    "custom_data":"Head of marketing"
  }
}' \
https://api.quickblox.com/users/96831397.json

4. As a result, the API returns a user with the specified updated fields.

curl -X PUT\
-H "Content-Type: application/json" \
-H 'Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI' \
-d '{  
  "user":{
    "login":"Jen_Lesser",
    "email":"[email protected]",
    "external_user_id":"1433712",
    "facebook_id":"125553",
    "full_name":"Jen Lesser",
    "phone":"+965234215",
    "website":"https://jen.com",
    "tag_list":"android,web",
    "custom_data":"Head of marketing"
  }
}' \
https://api.quickblox.com/users/96831397.json

Update user password with API key

1. Use 'Authorization' header to pass API key

curl -X PUT\
-H "Content-Type: application/json" \
-H 'Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI' \
-d '{  
  "user":{
    "password":"newpasswordforuser!"
  }
}' \
https://api.quickblox.com/users/96831397.json

2. Use a `user` parameter to set a new password

curl -X PUT\
-H "Content-Type: application/json" \
-H 'Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI' \
-d '{  
  "user":{
    "password":"newpasswordforuser!"
  }
}' \
https://api.quickblox.com/users/96831397.json

3. Set a new password

Use a password parameter to set a new password for the specified user

curl -X PUT\
-H "Content-Type: application/json" \
-H 'Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI' \
-d '{  
  "user":{
    "password":"newpasswordforuser!"
  }
}' \
https://api.quickblox.com/users/96831397.json

4. As a result, the API returns a user with an updated password.

curl -X PUT\
-H "Content-Type: application/json" \
-H 'Authorization: ApiKey 28irlNAGasWDSupO9Vw0BBMZfuHrAUYKpmroS9yBORI' \
-d '{  
  "user":{
    "password":"newpasswordforuser!"
  }
}' \
https://api.quickblox.com/users/96831397.json

Path Parameters

user_id

integer

required

ID of the user. Generated automatically by the server after user creation.

Body Parameters

user

object

required

Show User object properties

User login. Must be unique. Only one required: login or email.

string

required

User e-mail. Must be unique. Only one required: login or email.

password

string

required

User password.

blob_id

integer

ID of the file/blob. Generated automatically by the server after file/blob creation (for example, user photo).

external_user_id

integer

ID of the user in the external system (.). Must be unique.

facebook_id

string

ID of the user’s Facebook account. Must be unique.

full_name

string

User’s full name.

phone

string

User’s phone.

website

string

User’s website.

custom_data

string

User’s additional info.

User tags.

allow_sales_activities

boolean

deprecated

~~Marketing info.~~

allow_statistics_analysis

boolean

deprecated

~~Marketing info.~~

age_over16

boolean

deprecated

~~GDPR info.~~

parents_contacts

string

deprecated

~~GDPR info.~~

Headers

QB-Token

string

required

A user session token. See Authentication page to learn more about the session token.

Authorization

string

default:"ApiKey {your_api_key}"

required

API key from Dashboard. Expected format: ApiKey {your_api_key}. Must be used either QB-Token or Authorization.

Responses

200

A successful response

user

object

Show properties

integer

full_name

string

phone

string

website

string

created_at

string

updated_at

string

last_request_at

string

external_user_id

integer

facebook_id

string

twitter_id

string

blob_id

string

custom_data

string

age_over16

boolean

allow_statistics_analysis

boolean

allow_sales_activities

boolean

parents_contacts

string

user_tags

string

400

An error response

code

string

message

string

403

An error response

errors

object

Show properties

base

array of strings

422

An error response

errors

object

Show properties

base

array of strings

facebook_id

array of strings

twitter_id

array of strings

tag

array of strings

phone

array of strings

curl -X PUT \
-H "Content-Type: application/json" \
-H "QB-Token: 7483d80bb9caddd504764d85b050c85755aecc84" \
-d '{  
  "user":{  
    "login":"Jen_Lesser",
    "email":"[email protected]",
    "external_user_id":"1433712",
    "facebook_id":"125553",
    "full_name":"Jen Lesser",
    "phone":"+965234215",
    "website":"https://jen.com",
    "tag_list":"android,web",
    "custom_data":"Head of marketing"
  }
}' \
https://api.quickblox.com/users/96831397.json

{
  "user": {
    "id": 96831397,
    "full_name": "Jen Lesser",
    "email": "[email protected]",
    "login": "Jen_Lesser",
    "phone": "+965234215",
    "website": "https://jen.com",
    "created_at": "2019-08-29T19:15:17Z",
    "updated_at": "2019-09-01T14:03:58Z",
    "last_request_at": "2019-09-01T14:02:54Z",
    "external_user_id": 1433712,
    "facebook_id": "125553",
    "twitter_id": "998800",
    "blob_id": null,
    "custom_data": "Head of marketing",
    "age_over16": true,
    "allow_statistics_analysis": false,
    "allow_sales_activities": false,
    "parents_contacts": "",
    "user_tags": "android,web"
  }
}

REST API

​Recipes

​Path Parameters

​Body Parameters

​Headers

​Responses

Recipes

Path Parameters

Body Parameters

Headers

Responses