Skip to navigation

Create a User

In this code snippet you learn how to create a User.

Example

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

Key Description
USER_NAME The unique name of the User.
USER_DISPLAY_NAME The display name of the User.
  • cURL
  • Node.js

    • Prerequisites

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

    Write the code

    Add the following to create-user.sh:

    curl -X "POST" "https://api.nexmo.com/v0.1/users" \
     -H 'Authorization: Bearer '$JWT\
     -H 'Content-Type: application/json' \
     -d $'{
  "name": "$USER_NAME",
  "display_name": "$USER_DISPLAY_NAME"
}'

    View full source

    Run your code

    Save this file to your machine and run it: 

    bash create-user.sh

    Prerequisites

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

    npm install @vonage/server-sdk@beta

    Create a file named create-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 create-user.js:

    vonage.users.create({
    "name": USER_NAME,
    "display_name": USER_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 create-user.js

    Try it out

    When you run the code you will create a new User.

    Improve this page