Update clients

URL

POST https://{api-url}/api/v2/tenants/{varId}/clients/{clientId}

Sample URLs

https://{api-url}/api/v2/tenants/msp_92/clients/client_69883

Parameters

All of the fields are optional:

Field	Data Type	Description
name	String	Name of the client.
address	String	Address of the client.
timeZone	String	Country time zone. Opsramp supports a comprehensive list of timezones. Example: "timeZone": "America/Los_Angeles"
country		Name of the country. To view a list of countries, access the Get Countries API.
extOrgId	String	External organization ID.
channel id	Integer	Channel ID. To get list of available channels, access the Get Channels API.
city	String	City name.
state	String	State name.
zip	String	Zip code.
nocDetails id	String	NOC details. To get the list of available NOCs, access the Get Tenant NOCs API.
mobileNumber	String	Mobile number of client.
phoneNumber	String	Phone number of client.
phoneExtension	String	Phone number extension.
rdp2swfState	Boolean	A flag used that if rdp2swfState=true, converts remote console recordings to flash format.
enableCLIRecording	Boolean	Set enableCLIRecording=true to enable CLI recording.
showCopyClipBoard	Boolean	Show Copy to Clipboard.
agentPolicies1.name2.policies name enable	String	Name of the Agent Policy. Set enable=true to enable policies.
clientDetails businessStartHour businessStartMinute businessEndHour businessEndMin businessDayStart businessDayEnd smsVoiceNotification remoteAccess	Integer Integer Integer Integer Integer String Boolean Boolean	Start of the business hour. The format is 24-hour clock notation. Example: 02, 15 Start of the business minute. End of the business hour. The format is 24-hour clock notation. Example: 16, 20 End of the business minute. Start of the business day. Represented in numbers. Example: 2-Monday, 6-Friday End of the business day. Represented in numbers. Example: 1-Sunday, 7-Saturday Set as true to receive SMS Voice Notification . Set as true to enable remote access module . Note: This feature is enabled for clients only if remote access module is enabled at partner level.
9. resourceDecommission	Boolean	A resource can be decommissioned if you do not wish to manage the resource anymore. A resource moved into decommissioned state is not re-managed. Provide resourceDecommission: true to enable the module for a client. If you do not provide any value, the default value is false.
10. whiteListedIps		IP whitelisting is a security feature often used for limiting and controlling access only to trusted users. IP whitelisting allows you to create lists of trusted IP addresses or IP ranges from which your users can access your domains. Example: IP addresses can be of the form [172.22.22.*] or a range [172.22.2.{0-50}].

Status code

200 OK

Sample response

{
	"name": "GEO Services",
	"extOrgId": "Ext1010",
	"address": "GEO Services, Parkway",
	"channel": {
		"id": "7"
	},
	"nocDetails": {
		"id": "11"
	},
	"city": "San Jose",
	"state": "California",
	"zip": "95101",
	"country": "USA",
	"rdp2swfState": "true",
	"enableCLIRecording": "true",
	"phoneNumber": "408-555-1234",
	"phoneExtension": "+1",
	"mobileNumber": "646-222-3333",
	"timeZone": "America/Los_Angeles",
	"showCopyClipBoard": "true",
	"resourceDecommission": "false",
        "whiteListedIps" : "172.22.22.*,172.22.2.[0-50]",
	"clientDetails": {
		"smsVoiceNotification": "false",
		"businessStartHour": "10",
		"businessStartMin": "00",
		"businessEndHour": "20",
		"businessEndMin": "00",
		"businessDayStart": "2",
		"businessDayEnd": "6",
                "remoteAccess" : "true"
	},
	"agentPolicies": [{
			"id": "1",
			"name": "Servers Policy",
			"policies": [{
					"name": "PatchManagement",
					"enable": "true"
				},
				{
					"name": "sqlitedb",
					"enable": "true"
				}
			]
		},
		{
			"id": "2",
			"name": "Desktops Policy",
			"policies": [{
					"name": "PatchManagement",
					"enable": "true"
				},
				{
					"name": "sqlitedb",
					"enable": "false"
				}
			]
		},
		{
			"id": "3",
			"name": "Agent Policy",
			"policies": [{
					"name": "PatchManagement",
					"enable": "false"
				},
				{
					"name": "sqlitedb",
					"enable": "true"
				}
			]
		}
	]
}