HostedSuite

<back to all web services

UpdateScreenPopsRequest

Update a specific client's screen pops

The following routes are available for this service:
POST/api/clients/{clientId}/screen-pops
UpdateScreenPopsRequest Parameters:
NameParameterData TypeRequiredDescription
ClientIdpathstringYesThe unique ID of this client
ScreenPopsbodyList<string>YesThe list of screen pops to associate with this client
RequestBase<TResponse> Parameters:
NameParameterData TypeRequiredDescription
CustomerNameformstringYesThe HostedSuite Customer Name
UserNameformstringYesThe HostedSuite User Name. Data visibility and security is based on this user's permissions.
PasswordformstringYesThe HostedSuite User's Password
ClientInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DateLastModifiedformstringNo
NameformstringNo
CenterIdformstringNo
CenterNameformstringNo
ScreenPopsformList<string>No
GreetingformstringNo
CallInstructionsformstringNo
PopupInformationformstringNo
InformationformstringNo
FaxNumberformstringNo
CustomFieldsformList<CustomFieldInfo>No
AddressformAddressInfoNo
ThirdPartyAccountIdformstringNo
CallAllowanceTypeformCallAllowanceTypeNo
CallAllowanceAmountformdoubleNo
LinksformList<HyperlinkInfo>No
IndustryIdformstringNo
IndustryNameformstringNo
CategoriesformIList<CategoryInfo>No
LocationformstringNo
CustomFieldInfo Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
AddressInfo Parameters:
NameParameterData TypeRequiredDescription
Street1formstringNo
Street2formstringNo
CityformstringNo
StateformstringNo
PostalCodeformstringNo
CountryformstringNo
CallAllowanceType Enum:
NotBillable
NumberOfMinutes
NumberOfCalls
HyperlinkInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
UrlformstringNo
CategoryInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
ClientInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DateLastModifiedformstringNo
NameformstringNo
CenterIdformstringNo
CenterNameformstringNo
ScreenPopsformList<string>No
GreetingformstringNo
CallInstructionsformstringNo
PopupInformationformstringNo
InformationformstringNo
FaxNumberformstringNo
CustomFieldsformList<CustomFieldInfo>No
AddressformAddressInfoNo
ThirdPartyAccountIdformstringNo
CallAllowanceTypeformCallAllowanceTypeNo
CallAllowanceAmountformdoubleNo
LinksformList<HyperlinkInfo>No
IndustryIdformstringNo
IndustryNameformstringNo
CategoriesformIList<CategoryInfo>No
LocationformstringNo

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

HTTP + CSV

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

POST /api/clients/{clientId}/screen-pops HTTP/1.1 
Host: evo.hostedsuite.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ClientId":"String","ScreenPops":["String"],"CustomerName":"String","UserName":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":"String","DateLastModified":"String","Name":"String","CenterId":"String","CenterName":"String","ScreenPops":["String"],"Greeting":"String","CallInstructions":"String","PopupInformation":"String","Information":"String","FaxNumber":"String","CustomFields":[{"Name":"String","Value":"String"}],"Address":{"Street1":"String","Street2":"String","City":"String","State":"String","PostalCode":"String","Country":"String"},"ThirdPartyAccountId":"String","CallAllowanceType":"NotBillable","CallAllowanceAmount":0,"Links":[{"Id":"String","Name":"String","Url":"String"}],"IndustryId":"String","IndustryName":"String","Location":"String"}