AddContact

July 21, 2025

This API adds new contact information to a user.

The settings can be found on the AhsayCBS web console at:

  • Backup / Restore > Users, Groups & Policies > Backup User > %User Name% > User Profile > Contact

 

URL

https://CBS.EXAMPLE.COM/obs/api/json/AddContact.do

Available Since Version: 9.1

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin or API role.
SysPwd String Password matching SysUser.
LoginName String Backup user name.
Owner String Owner of the backup user (if applicable).
NewContact JSON Object Contact See Contact.
Return Values
Key Type Description
Status String "OK" or "Error"
Message String Error message, it only appears if status displays "Error".
ExptType String The type of exception, will only be displayed if the status is "Error".
JSON Objects

Contact

Key Type Description
Name String Name of the contact.
Email String Email address of the contact.
Example

INPUT 

{
	"SysUser":"system",
	"SysPwd":"system1",
	"LoginName":"obm",
	"NewContact":{
		"Name":"contact1",
		"Email":"contact1@examle.com"
	}
}

OUTPUT 

{
	"Status":"OK"
}

OUTPUT 2: Duplicate contact email 

{
	"Status":"Error",
	"Message":"[UpdateUserProfile.checkDuplicatedEmail] Contact already exists <contact1@example.com>",
	"ExptType":"com.ahsay.obs.core.dbs.DbsException"
}
Documentation