Create a user

Create a new user in a realm.

Note: The requesting user must be an administrator.


Usage examples

#!/usr/bin/env python

import zulip

# The user for this zuliprc file must be an organization administrator
client = zulip.Client(config_file="~/zuliprc-admin")

# Create a user
request = {
    'email': '[email protected]',
    'password': 'temp',
    'full_name': 'New User',
    'short_name': 'newbie'
result = client.create_user(request)

More examples and documentation can be found here.

const zulip = require('zulip-js');

// You need a zuliprc-admin with administrator credentials
const config = {
    zuliprc: 'zuliprc-admin',

zulip(config).then((client) => {
    // Create a user
    const params = {
        email: '[email protected]',
        password: 'temp',
        full_name: 'New User',
        short_name: 'newbie'

curl \
    -d "[email protected]" \
    -d "full_name=New User" \
    -d "short_name=newbie" \
    -d "password=temp"


Argument Example Required Description
email "[email protected]" Yes

The email address of the new user.

password "[email protected]" Yes

The password of the new user.

full_name "John Smith" Yes

The full name of the new user.

short_name "jsmith" Yes

The short name of the new user.


Example response

A typical successful JSON response may look like:

    "msg": "",
    "result": "success"

A typical JSON response for when another user with the same email address already exists in the realm:

    "msg": "Email '[email protected]' already in use",
    "result": "error"