mirror of
https://github.com/zulip/zulip.git
synced 2025-11-02 21:13:36 +00:00
929724e5e7
We now have a separate page for common error payloads, for example, the payload for when the client's API key is invalid. All error payloads that are presented on this page will be tested similarly to our other non-error sample fixtures.
1.7 KiB
1.7 KiB
Create a user
Create a new user in a realm.
Note: The requesting user must be an administrator.
POST {{ api_url }}/v1/users
Usage examples
- Python
- JavaScript
- curl
curl {{ api_url }}/v1/users \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY \
-d "email=newbie@zulip.com" \
-d "full_name=New User" \
-d "short_name=newbie" \
-d "password=temp"
{generate_code_example|create-user|example(admin_config=True)}
More examples and documentation can be found [here](https://github.com/zulip/zulip-js).
```js
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: 'newbie@zulip.com', password: 'temp', full_name: 'New User', short_name: 'newbie' }; client.users.create(params).then(console.log); });
</div>
</div>
</div>
## Arguments
{generate_api_arguments_table|arguments.json|create-user.md}
## Response
#### Example response
A typical successful JSON response may look like:
{generate_code_example|create-user|fixture}
A typical JSON response for when another user with the same
email address already exists in the realm:
{ 'msg':"Email 'newbie@zulip.com' already in use", 'result':'error' }