---
title: "Add a user"
method: POST
path: "/users"
tags: ["Users"]
---

# Add a user

`POST /users`

Add new user

## Request body

- object
  - `first_name` string, required — First name for new user.
  - `last_name` string, required — last name for new user.
  - `email` string, required — Email for user.
  - `group_id` integer, required — Set the group ID for the user. This can be found in the Groups section in Vrio.
  - `user_type` 'ui' | 'api_key', required — * `ui` - User Interface * `api_key` - API Key
  - `phone` string — Phone number for user.
  - `ip_whitelist` string — Set a comma separated list of IP Address that this user can access Vrio from.
  - `send_activation_email` boolean — Should an activation email be sent. This would only apply for UI users.
  - `password` string — The password must be at least 12 characters and contain at least one uppercase letter, one lower case letter and one number. Required if send_activation_email is false and user type is UI.
  - `active` boolean — Set the active status of a user.
  - `notes` string — Apply note to the history of this user.

## Response `200`

OK

- object
  - `user_id` integer
  - `first_name` string
  - `last_name` string
  - `phone` string, nullable
  - `email` string
  - `group_id` integer
  - `image` string, nullable
  - `last_login` integer, nullable
  - `ip_whitelist` string, nullable
  - `api_key` string, nullable
  - `user_type` 'ui' | 'api_key' — * `ui` - User Interface * `api_key` - API Key
  - `password_type` 'ui' | 'email' | 'api_key' — * `ui` - Define the password with the password paramter * `email` - Email the password to the user * `api_key` - API Key
  - `user_default` boolean
  - `user_identifier` string, nullable
  - `date_created` string, date-time, nullable
  - `created_by` integer
  - `date_modified` string, date-time
  - `modified_by` integer
  - `active` boolean
  - `notes` string, nullable
  - `campaign_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `company_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `item_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `merchant_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `offer_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `product_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `responder_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `route_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `user_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `order_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `transaction_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `customer_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `shipment_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `report_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `dunning_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `connection_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `merchant_group_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `user_group_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `user_password_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `team_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `return_profile_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `chargeback_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `api_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `bin_profile_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `tax_profile_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `timeframe_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `dashboard_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `widget_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `counter_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `alert_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `schedule_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `user_permission_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `cohort_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `discount_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `shipping_profile_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `gift_card_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `order_offer_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `quantity_discount_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `upsell_profile_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `tracker_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `payment_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `view_user_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `view_group_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `refund_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `store_credit_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `ruleset_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `promotional_profile_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `reward_profile_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access
  - `tag_permission_level_id` 1 | 2 | 3 | 4 — * `1` - No Access * `2` - Read Only * `3` - Create/Edit * `4` - Full Access

## Other responses

- `400` — Error response
- `401` — Unauthorized response
- `403` — Forbidden response
- `500` — Error response

---

[API](https://skmtc.net/vrio/apis/crm-configuration.md) · [All operations](https://skmtc.net/vrio/apis/crm-configuration/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vrio/crm-configuration/versions/62037010356e/schema)