HostedSuite

NewContactRequest

Create a new contact for the specified client

The following routes are available for this service:
POST	/api/contacts/new

**NewContactRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ClientId	body	string	Yes	The ID of the client to associate this contact with.
FirstName	body	string	No	The contact's first name
LastName	body	string	No	The contact's last name
Information	body	string	No	Information about the contact
GreetingOverride	body	string	No	This contact's greeting override
PhoneNumbers	body	List<PhoneNumberInfo>	No	This contact's phone numbers
EmailAddresses	body	List<EmailAddressInfo>	No	This contact's email address(es)
Links	body	List<HyperlinkInfo>	No	This contact's links
Alert	body	string	No	The alert to be displayed for the Contact
AlertExpirationDate	body	string	No	The date the alert expires. Leave blank to not expire
Status	body	string	No	The status to be displayed for the Contact
StatusExpirationDate	body	string	No	The date the status expires. Leave blank to not expire
LongDistanceCode	body	string	No	The Contact's long distance code
CallInstructions	body	string	No	The Instructions for the Contact
Title	body	string	No	The title for the Contact
Keywords	body	List<string>	No	A list of keywords for the Contact
CategoryIds	body	List<string>	No	The IDs of the categories to associate this contact with.
CustomFields	body	List<CustomFieldInfo>	No	Any custom fields for the Contact
LoginUserName	body	string	No	User name for the Contact to login with
LoginPassword	body	string	No	Password for the Contact to login with
LoginUserGroupId	body	string	No	User group to assign to this Contact
LoginMustChangePasswordAtNextLogin	body	bool?	No	The login must change password at next login
MoreInformation	body	string	No	Even more information about this Contact
ThirdPartyAccountId	body	string	No	Third party ID for this contact
Address	body	AddressInfo	No	The contact's address
EmergencyInstructions	body	string	No	The contact's emergency instructions
TimeZoneId	body	string	No	The contact's time zone ID (use the List Time Zones API to retrieve list of valid time zones)
SortPositionInConsole	body	int?	No	The contact's sort position in the console
HideInConsole	body	bool?	No	Should this contact be hidden in console

**RequestBase<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerName	form	string	Yes	The HostedSuite Customer Name
UserName	form	string	Yes	The HostedSuite User Name. Data visibility and security is based on this user's permissions.
Password	form	string	Yes	The HostedSuite User's Password

**ContactInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
DateLastModified	form	string	No
ClientName	form	string	No
ClientId	form	string	No
CenterId	form	string	No
CenterName	form	string	No
FirstName	form	string	No
LastName	form	string	No
Alert	form	string	No
Name	form	string	No
Status	form	string	No
Location	form	string	No
LongDistanceCode	form	string	No
CallInstructions	form	string	No
Information	form	string	No
MoreInformation	form	string	No
Title	form	string	No
UserName	form	string	No
UserGroupId	form	string	No
LoginMustChangePasswordAtNextLogin	form	bool	No
GreetingOverride	form	string	No
Keywords	form	List<string>	No
Address	form	AddressInfo	No
PhoneNumbers	form	List<PhoneNumberInfo>	No
EmailAddresses	form	List<EmailAddressInfo>	No
CustomFields	form	List<CustomFieldInfo>	No
Links	form	List<HyperlinkInfo>	No
Categories	form	List<CategoryInfo>	No
ThirdPartyAccountId	form	string	No
SortPositionInConsole	form	int	No
HideInConsole	form	bool	No

**AddressInfo** Parameters:
Name	Parameter	Data Type	Required
Street1	form	string	No
Street2	form	string	No
City	form	string	No
State	form	string	No
PostalCode	form	string	No
Country	form	string	No

**PhoneNumberInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Number	form	string	No
DialingRuleId	form	string	No
Mobile	form	bool	No
TransferTypes	form	TransferTypesApi	No

**TransferTypesApi** Enum:
Both
Blind
Supervised

**EmailAddressInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Address	form	string	No
Name	form	string	No
IncludeInNotifications	form	bool	No
Type	form	EmailAddressTypeValues	No	The type of email address (To, CC, BCC)

**EmailAddressTypeValues** Enum:
To
Cc
Bcc

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

**HyperlinkInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
Name	form	string	No
Url	form	string	No

**CategoryInfo** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	string	No
Name	form	string	No

**ContactInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
DateLastModified	form	string	No
ClientName	form	string	No
ClientId	form	string	No
CenterId	form	string	No
CenterName	form	string	No
FirstName	form	string	No
LastName	form	string	No
Alert	form	string	No
Name	form	string	No
Status	form	string	No
Location	form	string	No
LongDistanceCode	form	string	No
CallInstructions	form	string	No
Information	form	string	No
MoreInformation	form	string	No
Title	form	string	No
UserName	form	string	No
UserGroupId	form	string	No
LoginMustChangePasswordAtNextLogin	form	bool	No
GreetingOverride	form	string	No
Keywords	form	List<string>	No
Address	form	AddressInfo	No
PhoneNumbers	form	List<PhoneNumberInfo>	No
EmailAddresses	form	List<EmailAddressInfo>	No
CustomFields	form	List<CustomFieldInfo>	No
Links	form	List<HyperlinkInfo>	No
Categories	form	List<CategoryInfo>	No
ThirdPartyAccountId	form	string	No
SortPositionInConsole	form	int	No
HideInConsole	form	bool	No

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 /api/contacts/new HTTP/1.1 
Host: cpo.hostedsuite.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClientId: String,
	FirstName: String,
	LastName: String,
	Information: String,
	GreetingOverride: String,
	PhoneNumbers: 
	[
		{
			Id: String,
			Name: String,
			Number: String,
			DialingRuleId: String,
			Mobile: False,
			TransferTypes: Both
		}
	],
	EmailAddresses: 
	[
		{
			Id: String,
			Address: String,
			Name: String,
			IncludeInNotifications: False,
			Type: To
		}
	],
	Links: 
	[
		{
			Id: String,
			Name: String,
			Url: String
		}
	],
	Alert: String,
	AlertExpirationDate: String,
	Status: String,
	StatusExpirationDate: String,
	LongDistanceCode: String,
	CallInstructions: String,
	Title: String,
	Keywords: 
	[
		String
	],
	CategoryIds: 
	[
		String
	],
	CustomFields: 
	[
		{
			Name: String,
			Value: String
		}
	],
	LoginUserName: String,
	LoginPassword: String,
	LoginUserGroupId: String,
	LoginMustChangePasswordAtNextLogin: False,
	MoreInformation: String,
	ThirdPartyAccountId: String,
	Address: 
	{
		Street1: String,
		Street2: String,
		City: String,
		State: String,
		PostalCode: String,
		Country: String
	},
	EmergencyInstructions: String,
	TimeZoneId: String,
	SortPositionInConsole: 0,
	HideInConsole: False,
	CustomerName: String,
	UserName: String,
	Password: String
}

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

{
	Id: String,
	DateLastModified: String,
	ClientName: String,
	ClientId: String,
	CenterId: String,
	CenterName: String,
	FirstName: String,
	LastName: String,
	Alert: String,
	Name: String,
	Status: String,
	Location: String,
	LongDistanceCode: String,
	CallInstructions: String,
	Information: String,
	MoreInformation: String,
	Title: String,
	UserName: String,
	UserGroupId: String,
	LoginMustChangePasswordAtNextLogin: False,
	GreetingOverride: String,
	Keywords: 
	[
		String
	],
	Address: 
	{
		Street1: String,
		Street2: String,
		City: String,
		State: String,
		PostalCode: String,
		Country: String
	},
	PhoneNumbers: 
	[
		{
			Id: String,
			Name: String,
			Number: String,
			DialingRuleId: String,
			Mobile: False,
			TransferTypes: Both
		}
	],
	EmailAddresses: 
	[
		{
			Id: String,
			Address: String,
			Name: String,
			IncludeInNotifications: False,
			Type: To
		}
	],
	CustomFields: 
	[
		{
			Name: String,
			Value: String
		}
	],
	Links: 
	[
		{
			Id: String,
			Name: String,
			Url: String
		}
	],
	Categories: 
	[
		{
			Id: String,
			Name: String
		}
	],
	ThirdPartyAccountId: String,
	SortPositionInConsole: 0,
	HideInConsole: False
}