Skip to content

Create user

Request to create new user:

POST /api/v2/users.json

HTTP body should contain JSON formatted profile of user to create.

For example:

    "user": {
        "name": "John Smith",
        "role_id": "5b139cee-f13a-11e5-9615-e03f497dbdff",
        "group_id": "47f53fcc-9201-11e5-b4ef-e03f497dbdff",
        "timezone": "Europe/London",
        "fieldset_recording": {
            "extensions": ["2001", "2002"],
            "record": "always",
            "record_direction": ["in", "out"]
            "recording_seat": true,

Response contains HTTP status code as shown in the following table.

Response Description
201 Created

User record has been successfully created. HTTP header Location contains URL by which the newly created object should be know.

For example:

HTTP/1.1 201 Created Location: /api/v2/users/e011c408-f288-11e4-9b73-e03f497dbdff.json
403 Forbidden The request cannot be completed because API user has no permission to create users
400 Bad Request

The request cannot be completed because supplied JSON object has invalid data.

When response has content type application/json, then it contains more detailed description of error in JSON format like:

{"error": "InvalidRecord","description": "Record Validation errors","details": ["name": "User with such name exists already"]}