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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"ContactId":"String","ContactPhoneNumber":"String","CustomerName":"String","UserName":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}