HostedSuite

<back to all web services

ArchiveContactsRequest

Archives a contact

The following routes are available for this service:
POST/api/contacts/archive
ArchiveContactsRequest Parameters:
NameParameterData TypeRequiredDescription
ContactIdbodystringNoThe ID of the contact. Do not combine this field with the phone number filter.
ContactPhoneNumberbodystringNoThe phone number of contacts to archive. This may result in multiple contacts being archived.
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

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

HTTP + XML

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

POST /api/contacts/archive HTTP/1.1 
Host: evo.hostedsuite.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ArchiveContactsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel">
  <CustomerName>String</CustomerName>
  <Password>String</Password>
  <UserName>String</UserName>
  <ContactId>String</ContactId>
  <ContactPhoneNumber>String</ContactPhoneNumber>
</ArchiveContactsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DefaultResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Evo.HostedSuite.Core.ServiceModel" />