Add new user

Add a new user to VCC’s database.

Request
Method PUT
Resource https://[customer].asp.virtual-call-center.eu/v2/users
Options N/A
Body New user’s details, encoded in JSON
Response
Body Result encoded in JSON

Request

Resource parameters

Name Type Mandatory Comment
customer string yes Your call centre’s unique identifier (subdomain).

Request object

Name Type Mandatory Comment
is_agent boolean yes Defines the user’s type. Possible values:
– true
– false
name string yes User’s name.
password string yes The user’s password, created within the parameters of the previously set password policy. The data added is encrypted.
role_id integer yes Defines the user’s right.
username string yes The user’s username.

Response

See examples below.

Example

Request

URL: https://mycc.asp.virtual-call-center.eu/v2/users

Request body

{
    "name": "Joseph Landry",
    "username": "joseph",
    "password": "LKU76.GFTR#23",
    "is_agent": true,
    "role_id": 4
}

Response body

{
    "response": 33,
    "errors": []
}

Possible errors

HTTP Code Message Description
417 error.name_must_be_between The name is too short or long.
417 error.non_exist The specified role does not exist in VCC’s database.
417 error.password_policy_min_chars_error The password added is too short (based on the password policy previously set in VCC).
417 error.password_policy_min_number_chars_error The password added contains less than the minimum number of numbers required (based on the password policy previously set in VCC).
417 error.password_policy_min_special_chars_error The password added contains less than the minimum number of special characters required (based on the password policy previously set in VCC).
417 error.password_policy_min_uppercase_chars_error The password added contains less than the minimum number of uppercase letters required (based on the password policy previously set in VCC).
417 error.required Missing value on a mandatory key.
417 error.reserved_username_prefix The username starts with a reserved username prefix (vcc_).
417 error.reserved The added role is reserved for VCC.
417 error.role_mismatch The value on the [is_agent] or the [role] key is not supported.
417 error.username_already_exists The username already exists in VCC’s database.
417 error.username_must_be_between The username is too short or long.
417 error.wrong_value_format The value format on the [is_agent] or the [role] key is not supported.
417 error.wrong_name_format The name contains one or more non-supported characters eg: special character.
417 error.wrong_username_format The username contains one or more non-supported characters eg: special character.
417 error.wrong_username_only_consists_small_letters The username contains one or more uppercase letters.

There are no comments yet.

Comment

Subscribe to our newsletter
or Contact us!
Please note that by subscribing to our newsletter, you agree to receive regular email messages from VCC Live about service related news and updates. By subscribing to our newsletter, you also agree that VCC Live will use your data in accordance with the applicable Privacy Policy until you unsubscribe from the newsletter.