Update a User

In this code snippet you learn how to update a User's details.

Example

Ensure the following variables are set to your required values using any convenient method:

Key	Description
`USER_ID`	The unique ID of the User.
`USER_NEW_NAME`	The new name of the User.
`USER_NEW_DISPLAY_NAME`	The new display name of the User.

Prerequisites

You will need to use an existing Application and have a User in order to be able to update a User. See the Create Conversation code snippet for information on how to create an Application. See also the Create User code snippet on how to create a User.

Write the code

Add the following to update-user.sh:

curl -X "PUT" "https://api.nexmo.com/beta/users/$USER_ID" \
     -H 'Authorization: Bearer '$JWT\
     -H 'Content-Type: application/json' \
     -d $'{
  "name": "$USER_NEW_NAME",
  "display_name": "$USER_NEW_DISPLAY_NAME"
}'

View full source

Run your code

Save this file to your machine and run it:

bash update-user.sh

Prerequisites

npm install @vonage/server-sdk@beta

Create a file named update-user.js and add the following code:

const Vonage = require('@vonage/server-sdk')

const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
  applicationId: VONAGE_APPLICATION_ID,
  privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH
})

View full source

Write the code

Add the following to update-user.js:

vonage.users.update(USER_ID, {
    "name": USER_NEW_NAME,
    "display_name": USER_NEW_DISPLAY_NAME}, (error, result) => {
        if(error) {
            console.error(error);
        }
        else {
            console.log(result);
        }
    });

View full source

Run your code

Save this file to your machine and run it:

node update-user.js

Try it out

When you run the code you will update the name and display name of the specified User.

Improve this page