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

ChangeDetails

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

This function allow you to change your own details.

Roles Requires: Admin, User and Private User.

Request Syntax

{
    "apiKey": "String",
    "firstName": "String",
    "lastName": "String",
    "areaCode":123456789,
    "phone": "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 you would like to give yourself.

Type :

String

Is it Optional ? :

No.


Parameter Name :

lastName

Parameter Usage and Options :

The Last Name you would like to give yourself.

Type :

String

Is it Optional ? :

No.


Parameter Name :

areaCode

Parameter Usage and Options :

Insert the Area Code of the User’s Phone. Refer to this site for more info.

Type :

String

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.


Successful Response

{
    "Error": 0,
    "Function": "ChangeDetails",
    "Data": "Update"
}

Errors and their Possible Causes

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