API Reference

Update End User Details

patch
https://{account}.sysaidit.com/connect/v1/end-users/

Update the details of an existing end user identified by their SysAid ID. The new values provided will overwrite existing values.

Path Params
int64
required

The end user's unique SysAid ID.

Query Params
expand
array of strings

Include additional related data in the response for the selected entity/entities.

Body Params
string
length ≤ 64

The user's first name. Max length is 64 characters.

string
length ≤ 64

The user's last name. Max length is 64 characters.

string

The user's display name

string

The user's email address.

boolean

A diasbled user is listed in the system, but does not have access to it. Default value is 'no' (user has access).

Unique ID of the company the user works for

Unique ID of the department the user belongs to.

Unique ID of the location associated with the user.

string

The user's timezone. By default, the timezone will be set to the one chosen for your SysAid account.

string

The language used by the user. The default value is English.

string

User's work phone number/extension

string

User's mobile number.

boolean

Enable or disable automatic service record email notifications when a service record is updated.

boolean

Enable the user to log into the Self-Service Portal.

integer

Unique ID of the user's manager.

string
enum

Give the user access to Self-Service Portal service records created by other users.
There are 3 levels:

  • Regular user: Cannot view service records that do not belong to them (default).
  • Department: Can view service records created by anyone in their department.
  • Company: Can view service records created by anyone in the company.
Allowed:
string | null

The user's job title.

int32
required

The version parameter is used for optimistic locking to prevent conflicts from concurrent updates. When updating a resource, you must include its current version value as received in the last GET request. If the version you provide does not match the latest version on the server, the update will be rejected. This ensures that you are not unintentionally overwriting changes made by another user or process, helping maintain data consistency and integrity.

Responses

Updated 11 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago