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

# Create a user

`POST /users`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/users`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/users/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a new user. Returns a unique user ID for a successful request.
            <br />***Note:*** Available for subscribers with the Admin User and Super Admin secondary roles.

## Request body

- ServiceChannelServicesMessagingUsersAddUserRequest: AddUserRequest class definition
  - `UserName` string: Gets or sets User name.
  - `Id` integer: Get or set User's identifier (id)
  - `InfoSubscriberId` integer: Gets or sets InfoSubscriberId.
  - `Password` string: Gets or sets Password.
  - `Email` string: Gets or sets Email.
  - `LocationAccess` string: Gets or sets LocationAccess.
  - `FeedRole` string: Gets or sets FeedRole.
  - `User` ServiceChannelServicesMessagingUsersUser: User details object.
    - `Id` integer: Unique user identifier.
    - `SubscriberId` integer: Unique subscriber ID.
    - `UserName` string: Username of the user.<br /> • For subscriber users, the username appears as **User Id** on the "General Info" tab of the user profile page.<br /> • For provider users, the username is listed as **UserID** under "Access" on the "General" tab of the user profile page.
    - `FullName` string: Full name of the user.<br /> • For subscriber users, the full name appears as **User Name** on the "General Info" tab of the user profile page.<br /> • For provider users, you can see their first and last name under "Basic" on the "General" tab of the user profile page.
    - `Email` string: User’s email address.
    - `PsmEmail` string: Email address through which a user can reset their password.
    - `Disabled` boolean: Defines if a user is deactivated.
    - `IsLocked` boolean: Defines if a user is locked.
    - `Roles` string[]: Secondary roles assigned to a subscriber user that determine their permissions and level of access to various Service Automation modules.
    - `Permissions` string[]: Permissions assigned to a subscriber user that determine whether they have full or read-only access to various Service Automation modules.
    - `UserType` 'Corporate' | 'Dashboard' | 'ServiceChannel': Subscriber user type defining their level of access to ServiceChannel:<br /> • `Corporate` — a user can work in Service Automation.<br /> • `Dashboard` — a user can only access the dashboard assigned to them.<br />`0` is returned for provider users.
    - `Dashboard` ServiceChannelServicesMessagingUsersDashboardInfo: Dashboard details object.
      - `Id` integer: Unique dashboard identifier.
      - `Name` string: Dashboard name.
      - `RedirectToDashboard` boolean: Defines whether a subscriber user is redirected to a dashboard once they log in.
    - `Access` ServiceChannelServicesMessagingUsersAccessOptions: Object listing locations, districts, regions, and trades a subscriber user has access to. Learn more about [granting access based on locations, districts, and regions](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/585107276/Location+District+Region+Access+Tab) in ServiceChannel University.
      - `Locations` string[]: Locations a user has access to.
      - `Districts` string[]: Districts a user has access to.
      - `Regions` string[]: Regions a user has access to.
      - `Trades` string[]: Trades a user is permitted to work with.
    - `Limits` ServiceChannelServicesMessagingUsersLimitOptions: Object for NTE, proposal, and invoice limits set for a subscriber user.
      - `NteLimit` ServiceChannelServicesMessagingUsersLimit: Object for limit details set for a subscriber user.
        - `Amount` number, double: Limit amount.
        - `CurrencyId` integer: Identifier of the currency the limit is set in.
      - `ProposalLimit` ServiceChannelServicesMessagingUsersLimit: Object for limit details set for a subscriber user.
        - `Amount` number, double: Limit amount.
        - `CurrencyId` integer: Identifier of the currency the limit is set in.
      - `InvoiceLimit` ServiceChannelServicesMessagingUsersLimit: Object for limit details set for a subscriber user.
        - `Amount` number, double: Limit amount.
        - `CurrencyId` integer: Identifier of the currency the limit is set in.
    - `FeedRole` string
    - `MliUserInfo` ServiceChannelServicesMessagingUsersMliUserInfo
      - `Id` integer
      - `MliLevel` string
      - `MliLocations` integer[]
    - `MlpUserInfo` ServiceChannelServicesMessagingUsersMlpUserInfo
      - `Id` integer
      - `MlpLevel` string
      - `MlpLocations` integer[]

## Response `200`

OK

- SystemObject

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)