---
title: "Create a New End User"
method: POST
path: "/end-users"
tags: ["End Users"]
---

# Create a New End User

`POST /end-users`

Creates a new end user in your SysAid account.

## Query parameters

- `sendPasswordNotification` boolean

## Request body

- EndUserCreate
  - `firstName` string, required — The user's first name.
  - `lastName` string — The user's last name.
  - `displayName` string — The user's display name
  - `userEmail` string — The user's email address.
  - `isDisabled` boolean — Indicates if the user is disabled
  - `companyId` number, nullable — Unique ID of the company the user works for
  - `departmentId` number, nullable — Unique ID of the department the user belongs to
  - `locationId` number, nullable — Unique ID of the location associated with the user
  - `timezone` string — The time zone of the user
  - `language` string — The language used by the user (default is "en")
  - `workPhone` string — User's work phone number/extension
  - `mobile` string — User's mobile number
  - `receiveSRNotifications` boolean — Enable or disable automatic SR email notifications
  - `enablePortalLogin` boolean — Enable login to the End User Portal
  - `managerId` integer
  - `supervisorLevel` 'none' | 'department' | 'company' — Enable the user to have access to other's ssp tickets
  - `jobTitle` string, nullable — User's job title
  - `customColumnsFields` FlattenedCustomColumnsFields
  - `userName` string, required — The name of the user as provided by the SysAdmin
  - `company` Company
    - `name` string, nullable — Name of the company.
    - `address` string, nullable — Main company address.
    - `address2` string, nullable — Additional company address.
    - `city` string, nullable — The city in which the company is located.
    - `state` string, nullable — The state in which the company is located.
    - `zip` string, nullable — The company's zip code.
    - `country` string, nullable — The country in which the company is located.
    - `phone` string, nullable — The company’s phone number.
    - `fax` string, nullable — The company’s fax number.
    - `notes` string, nullable — Notes related to the company.
    - `emailAccount` string, nullable — Default email account.
    - `expirationDate` string, date, nullable — The date when the company's access to the help will expire.
    - `agreementId` integer, nullable — The ID of the SLA applied to the company.
    - `agreementStartDate` string, date, nullable — The start date of your service agreement with the company.
    - `agreementEndDate` string, date, nullable — The end date of your service agreement with the company.
    - `customFields` object — Company custom fields.
    - `version` integer, required — The latest retrievable version of the company and its details.
    - `id` integer, required — The unique identifier of the company in SysAid.
  - `groups` Group[]
    - `name` string, required — The group's name.
    - `type` 'general' | 'administrators' | 'end-users', required — The group type.
    - `supportLevel` integer — A number representing the support level (from existing support levels).
    - `companyId` integer, nullable — The unique identifier for the company associated with the group.
    - `email` string, email — The email address associated with the group.
    - `receiveAutomaticSrEmailNotifications` boolean — Indicates whether the group receives automatic SR email notifications.
    - `canBeAssignedToServiceRecord` boolean — Indicates if the group can be assigned to a service record. Not applicable if `type` is set to `END_USERS`.
    - `enableAutomaticDispatchOfServiceRecords` boolean — Determines if service records should be automatically dispatched. Only applicable if `canBeAssignedToServiceRecord` is `true`
    - `id` integer, required — The unique identifier of the group.
  - `initialPassword` string — User's password to log into SysAid. Must be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, and one number or special character. If left empty, SysAid will auto-generate a password.

## Response `201`

End user created successfully

- UserCreateResponse
  - `success` boolean
  - `userId` integer — The user's unique ID within SysAid

## Other responses

- `400` — The request was invalid or cannot be served
- `401` — Authentication information is missing or invalid
- `403` — The server understood the request but refuses to authorize it
- `409` — The request could not be completed due to a conflict with the current state of the resource. This typically occurs when attempting to create a duplicate resource, update a resource that has been modified by another process, or when business rules prevent the operation.

---

[API](https://skmtc.net/sysaid/apis/sysaid-public-api.md) · [All operations](https://skmtc.net/sysaid/apis/sysaid-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sysaid/sysaid-public-api/versions/38a43a1b2981/schema)