Evo Voice

PatchSystemSettings

Updates the system settings

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager, Customer

The following routes are available for this service:
PATCHY	/system/settings

**PatchSystemSettings** Parameters:
Name	Parameter	Data Type	Required	Description
OverrideSystemTime	query	bool?	No	Use to override the system time for testing
OverrideSystemTimeZoneId	query	string	No	The system override time zone
OverrideSystemDateTime	query	string	No	The system override date/time
AccountId	query	string	No	The account ID of the system settings
SystemFields	query	List<SystemSettingsField>	No	The list of system settings fields
CustomerFields	query	List<CustomerDataField>	No	The list of customer fields
EndpointFields	query	List<EndpointDataField>	No	The list of endpoint fields
EmailAccounts	query	List<EmailAccount>	No	The list of email accounts
Tags	query	List<Tag>	No	The list of tags
Documentation	query	string	No	Documentation for the account
RecordingRetentionDays	query	int?	No	The number of days recordings are retained
EnableSipRefer	query	bool?	No	Enable the SIP refer beta
AutoAgentLogoffSeconds	query	int?	No	The number of seconds after which we automatically logoff a not ready agent
DefaultSipRegion	query	TwilioSipRegions?	No	The default SIP region for new devices

**SystemSettingsField** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	Value	No

**DataField** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Type	form	ValueTypes	No
UIHint	form	UIHints	No
UITab	form	string	No
IsAsync	form	bool	No
DisableBinding	form	bool	No
StructType	form	DataType	No
ListType	form	DataType	No
Description	form	string	No
PossibleValues	form	List<string>	No
IsOutput	form	bool	No
CustomFieldValuesUrl	form	string	No
DefaultValue	form	Value	No
TransitionNameFormat	form	string	No
Uniqueness	form	DataFieldUniqueness	No
VoiceOnly	form	bool	No
ConditionalVisibilityField	form	string	No
ConditionalVisibilityValue	form	string	No
NoEvalTemplate	form	bool	No
UserMode	form	UserDataFieldModes	No
AnyValueType	form	bool	No

**ValueTypes** Enum:
NotSpecified
String
Boolean
Number
List
Struct
Transition
Custom
Date
AudioFile
TimeZoneId
PhoneNumber
User
Endpoint
Time
File
FaxNumber
EmailAccount
Customer
Flow
Team
FlowReference
Integration
Assistant

**UIHints** Enum:
None
LargeText
InlineForm
Password
InlineStruct

**DataType** Parameters:
Name	Parameter	Data Type	Required	Description
TypeName	form	string	No
Fields	form	List<DataField>	No

**Value** Parameters:
Name	Parameter	Data Type	Required
BoolValue	form	bool?	No
StringValue	form	string	No
NumberValue	form	double?	No
ListValue	form	List<Struct>	No
StructValue	form	Struct	No

**DataFieldUniqueness** Enum:
NotUnique
Unique
UniqueToCustomer

**UserDataFieldModes** Enum:
Hidden
ReadOnly
ReadWrite

**CustomerDataField** Parameters:
Name	Parameter	Data Type	Required	Description
ShowInSearch	form	bool	No

**EndpointDataField** Parameters:
Name	Parameter	Data Type	Required
ShowInSearch	form	bool	No
ShowInLists	form	bool	No
EndpointType	form	EndpointTypes?	No
IsCallerId	form	bool	No
IsKnob	form	bool	No

**EndpointTypes** Enum:
PhoneNumber
User
FaxNumber
EmailAddress
Unused_1
Unused_2
Unused_3
Unused_4
Unused_5
Team
Assistant

**EmailAccount** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Server	form	string	No
UserName	form	string	No
Port	form	int	No
EmailAddress	form	string	No
DisplayName	form	string	No
Password	form	string	No

**Tag** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Color	form	TagColors	No

**TagColors** Enum:
Magenta
Red
Volcano
Orange
Gold
Lime
Green
Cyan
Blue
GeekBlue
Purple

**TwilioSipRegions** Enum:
NorthAmericaVirginia
NorthAmericaOregon
EuropeIreland
EuropeFrankfurt
AsiaPacificSingapore
AsiaPacificTokyo
AsiaPacificSydney
SouthAmericaSanPaolo

**SystemSettingsInfo** Parameters:
Name	Parameter	Data Type	Required	Description
OverrideSystemTime	form	bool	No	Use to override the system time for testing
OverrideSystemTimeZoneId	form	string	No	The system override time zone
OverrideSystemDateTime	form	string	No	The system override date/time
SystemFields	form	List<SystemSettingsField>	No	The list of system settings fields
CustomerFields	form	List<CustomerDataField>	No	The list of customer metadata fields
EndpointFields	form	List<EndpointDataField>	No	The list of endpoint metadata fields
EmailAccounts	form	List<EmailAccount>	No	The list of email accounts
Tags	form	List<Tag>	No	The list of tags in the system
Documentation	form	string	No	Documentation for the account
RecordingRetentionDays	form	int	No	The number of days recordings are retained
EnableSipRefer	form	bool	No	Enable the SIP refer beta
AutoAgentLogoffSeconds	form	int	No	The number of seconds after which we automatically logoff a not ready agent
DefaultSipRegion	form	TwilioSipRegions?	No	The default SIP region for new devices

**EntityInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No	The ID of the object
DateCreated	form	string	No	The date the object was created
DateLastModified	form	string	No	The date the object was last modified
CreatedBy	form	string	No	The user that created this object
LastModifiedBy	form	string	No	The user that last modified this object

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /system/settings HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	overrideSystemTime: False,
	overrideSystemTimeZoneId: String,
	overrideSystemDateTime: String,
	accountId: String,
	systemFields: 
	[
		{
			value: 
			{
				boolValue: False,
				stringValue: String,
				numberValue: 0,
				listValue: 
				[
					null
				]
			},
			id: String,
			name: String,
			type: NotSpecified,
			uiHint: None,
			uiTab: String,
			isAsync: False,
			disableBinding: False,
			description: String,
			possibleValues: 
			[
				String
			],
			isOutput: False,
			customFieldValuesUrl: String,
			defaultValue: 
			{
				boolValue: False,
				stringValue: String,
				numberValue: 0,
				listValue: 
				[
					null
				]
			},
			transitionNameFormat: String,
			uniqueness: NotUnique,
			voiceOnly: False,
			conditionalVisibilityField: String,
			conditionalVisibilityValue: String,
			noEvalTemplate: False,
			userMode: Hidden,
			anyValueType: False
		}
	],
	customerFields: 
	[
		{
			showInSearch: False,
			id: String,
			name: String,
			type: NotSpecified,
			uiHint: None,
			uiTab: String,
			isAsync: False,
			disableBinding: False,
			description: String,
			possibleValues: 
			[
				String
			],
			isOutput: False,
			customFieldValuesUrl: String,
			defaultValue: 
			{
				boolValue: False,
				stringValue: String,
				numberValue: 0,
				listValue: 
				[
					null
				]
			},
			transitionNameFormat: String,
			uniqueness: NotUnique,
			voiceOnly: False,
			conditionalVisibilityField: String,
			conditionalVisibilityValue: String,
			noEvalTemplate: False,
			userMode: Hidden,
			anyValueType: False
		}
	],
	endpointFields: 
	[
		{
			showInSearch: False,
			showInLists: False,
			endpointType: PhoneNumber,
			isCallerId: False,
			isKnob: False,
			id: String,
			name: String,
			type: NotSpecified,
			uiHint: None,
			uiTab: String,
			isAsync: False,
			disableBinding: False,
			description: String,
			possibleValues: 
			[
				String
			],
			isOutput: False,
			customFieldValuesUrl: String,
			defaultValue: 
			{
				boolValue: False,
				stringValue: String,
				numberValue: 0,
				listValue: 
				[
					null
				]
			},
			transitionNameFormat: String,
			uniqueness: NotUnique,
			voiceOnly: False,
			conditionalVisibilityField: String,
			conditionalVisibilityValue: String,
			noEvalTemplate: False,
			userMode: Hidden,
			anyValueType: False
		}
	],
	emailAccounts: 
	[
		{
			id: String,
			server: String,
			userName: String,
			port: 0,
			emailAddress: String,
			displayName: String,
			password: String
		}
	],
	tags: 
	[
		{
			id: String,
			name: String,
			color: Magenta
		}
	],
	documentation: String,
	recordingRetentionDays: 0,
	enableSipRefer: False,
	autoAgentLogoffSeconds: 0,
	defaultSipRegion: NorthAmericaVirginia
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	overrideSystemTime: False,
	overrideSystemTimeZoneId: String,
	overrideSystemDateTime: String,
	systemFields: 
	[
		{
			value: 
			{
				boolValue: False,
				stringValue: String,
				numberValue: 0,
				listValue: 
				[
					null
				]
			},
			id: String,
			name: String,
			type: NotSpecified,
			uiHint: None,
			uiTab: String,
			isAsync: False,
			disableBinding: False,
			description: String,
			possibleValues: 
			[
				String
			],
			isOutput: False,
			customFieldValuesUrl: String,
			defaultValue: 
			{
				boolValue: False,
				stringValue: String,
				numberValue: 0,
				listValue: 
				[
					null
				]
			},
			transitionNameFormat: String,
			uniqueness: NotUnique,
			voiceOnly: False,
			conditionalVisibilityField: String,
			conditionalVisibilityValue: String,
			noEvalTemplate: False,
			userMode: Hidden,
			anyValueType: False
		}
	],
	customerFields: 
	[
		{
			showInSearch: False,
			id: String,
			name: String,
			type: NotSpecified,
			uiHint: None,
			uiTab: String,
			isAsync: False,
			disableBinding: False,
			description: String,
			possibleValues: 
			[
				String
			],
			isOutput: False,
			customFieldValuesUrl: String,
			defaultValue: 
			{
				boolValue: False,
				stringValue: String,
				numberValue: 0,
				listValue: 
				[
					null
				]
			},
			transitionNameFormat: String,
			uniqueness: NotUnique,
			voiceOnly: False,
			conditionalVisibilityField: String,
			conditionalVisibilityValue: String,
			noEvalTemplate: False,
			userMode: Hidden,
			anyValueType: False
		}
	],
	endpointFields: 
	[
		{
			showInSearch: False,
			showInLists: False,
			endpointType: PhoneNumber,
			isCallerId: False,
			isKnob: False,
			id: String,
			name: String,
			type: NotSpecified,
			uiHint: None,
			uiTab: String,
			isAsync: False,
			disableBinding: False,
			description: String,
			possibleValues: 
			[
				String
			],
			isOutput: False,
			customFieldValuesUrl: String,
			defaultValue: 
			{
				boolValue: False,
				stringValue: String,
				numberValue: 0,
				listValue: 
				[
					null
				]
			},
			transitionNameFormat: String,
			uniqueness: NotUnique,
			voiceOnly: False,
			conditionalVisibilityField: String,
			conditionalVisibilityValue: String,
			noEvalTemplate: False,
			userMode: Hidden,
			anyValueType: False
		}
	],
	emailAccounts: 
	[
		{
			id: String,
			server: String,
			userName: String,
			port: 0,
			emailAddress: String,
			displayName: String,
			password: String
		}
	],
	tags: 
	[
		{
			id: String,
			name: String,
			color: Magenta
		}
	],
	documentation: String,
	recordingRetentionDays: 0,
	enableSipRefer: False,
	autoAgentLogoffSeconds: 0,
	defaultSipRegion: NorthAmericaVirginia,
	id: String,
	dateCreated: String,
	dateLastModified: String,
	createdBy: String,
	lastModifiedBy: String
}