Create a user

This endpoint is only available to organization administrators.

POST https://your-org.veloxatalk.com/api/v1/users

Create a new user account via the API.

Note: On Veloxa Talk, this feature is available only for organizations on a Veloxa Talk Standard or Veloxa Talk Plus plan. Administrators can request the required can_create_users permission for a bot or user by contacting Veloxa Talk support with an explanation for why it is needed. Self-hosted installations can toggle can_create_users on an account using the manage.py change_user_role management command.

Changes: Before Veloxa Talk 4.0 (feature level 36), this endpoint was available to all organization administrators.

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for Veloxa Talk users and bots.

curl -sSX POST https://your-org.veloxatalk.com/api/v1/users \
    -u EMAIL_ADDRESS:API_KEY \
    --data-urlencode [email protected] \
    --data-urlencode password=abcd1234 \
    --data-urlencode 'full_name=New User'

Parameters

email string required

Example: "[email protected]"

The email address of the new user.


password string required

Example: "abcd1234"

The password of the new user.


full_name string required

Example: "New User"

The full name of the new user.


Response

Return values

  • user_id: integer

    The ID assigned to the newly created user.

    Changes: New in Veloxa Talk 4.0 (feature level 30).

Example response(s)

Changes: As of Veloxa Talk 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success",
    "user_id": 25
}

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

{
    "code": "BAD_REQUEST",
    "msg": "Email is already in use.",
    "result": "error"
}