1. Home
  2. Docs
  3. API Documentation
  4. Users
  5. ChangeDetailsUser

ChangeDetailsUser

Route: https://kayran.live/api/ChangeDetailsUser

This function allow you to change another user’s details.

Roles Required: Admin.

Request Syntax

{
    "apiKey": "String",
    "firstName": "String",
    "lastName": "String",
    "id": 0123456789,
    "phone": "String",
    "role": "String",
    "projectName": "String"
    "title": "String"
}

Request Parameters

Parameters being used in the Request

Parameter Name :

apiKey

Parameter Usage and Options :

Your Kayran given API Key.

How do I get it ? :

Located in the “Profile” section.

Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.

Type :

String

Is it Optional ? :

No.


Parameter Name :

firstName

Parameter Usage and Options :

The First Name of the person who will be using Kayran.

Type :

String

Is it Optional ? :

No.


Parameter Name :

lastName

Parameter Usage and Options :

The Last Name of the person who will be using Kayran.

Type :

String

Is it Optional ? :

No.


Parameter Name :

id

Parameter Usage and Options :

The ID of the user whose details you wish to change.

How do I get it ? :

Use the “GetUser” or “GetUsers functions, or, use the users table in the “Users” sub-section under the “Manage” section.

Type :

Integer

Is it Optional ? :

No.


Parameter Name :

phone

Parameter Usage and Options :

The phone number of the user using this account.

Type :

String

Is it Optional ? :

No.


Parameter Name :

role

Parameter Usage and Options :

The role of the account that you wish to change.

Value :

user\admin\private user

Type :

String

Is it Optional ? :

No.


Parameter Name :

projectName

Parameter Usage and Options :

In case you wish to associate this user with a specific project.

How do I get it ? :

From the projects table in the “Projects” sub-section, or, use the “GetProjects” function

Type :

String

Is it Optional ? :

No.


Parameter Name :

title

Parameter Usage and Options :

In case you wish to attach a certain title to the user (Employee, Engineer etc.).

Type :

String

Is it Optional ? :

No.


Successful Response


{
    "Error": 0,
    "Function": "ChangeDetailsUser",
    "Data": "Change"
}

Errors and their Possible Causes

For more information, please refer to the General Errors section.