Route: https://api.cytrix.io/UpdateCompany
This feature allow users to update their server’s info (such as Phone, Address etc.)
Roles Required: Admin.
Request Syntax
{
"apiKey": "String",
"name": "String",
"description": Enter text as you like, "address": "String",
"areaCode":123456789,
"phone": 0123456789(String),
"email": "[email protected]",
"website": "www.aaa.com",
"timeZoneOffset": +|- 00:00,
"mailNotify":"true\false"
}
Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your CYTRIX 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 :
name
Parameter Usage and Options :
Name of the server\company you wish to be changed to.
Value :
Text, preferably without the use of numbers or special characters.
Type :
String
Is it Optional ? :
No.
Parameter Name :
description
Parameter Usage and Options :
There is an option to write a description for the company\server.
Value :
Any text you wish to use.
Type :
String
Is it Optional ? :
Yes
Parameter Name :
address
Parameter Usage and Options :
There is an option to assign an address to the company.
Value :
Any text you wish to use.
Type :
String
Is it Optional ? :
Yes
Parameter Name :
areaCode
Parameter Usage and Options :
Insert the Area Code of your Company Phone. Refer to this site for more info.
Type :
String
Is it Optional ? :
No.
Parameter Name :
phone
Parameter Usage and Options :
Assign a phone number to the company.
Type :
String
Is it Optional ? :
No.
Parameter Name :
Parameter Usage and Options :
Assign an email address to the company.
Type :
String
Is it Optional ? :
No.
Parameter Name :
website
Parameter Usage and Options :
There is an option to assign a website to the company.
Type :
String
Is it Optional ? :
Yes.
Parameter Name :
timeZoneOffset
Parameter Usage and Options :
There is an option to assign a specific time zone to the company’s server.
Note : we recommend doing so, to keep track of times and notifications appropriately.
Type :
String
Is it Optional ? :
Yes.
Parameter Name :
mailNotify
Parameter Usage and Options :
In case you want to turn on / off receiving email notifications.
Value :
true / false.
Type :
Boolean
Is it Optional ? :
No.
Successful Response
{
"Error": 0,
"Function": "UpdateCompany",
"Data": "update"
}Errors and their Possible Causes
For more information, please refer to the General Errors section.