POST | /api/contacts/archive |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ContactId | body | string | No | The ID of the contact. Do not combine this field with the phone number filter. |
ContactPhoneNumber | body | string | No | The phone number of contacts to archive. This may result in multiple contacts being archived. |
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 |
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
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: cpo.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 {}