POST | /api/contacts/delete |
---|
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 delete. This may result in multiple contacts being deleted. |
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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contacts/delete HTTP/1.1
Host: cpo.hostedsuite.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ContactId: String,
ContactPhoneNumber: String,
CustomerName: String,
UserName: String,
Password: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { }