deleteContacts¶
Request Method: DELETE
Description: Deletes the specified contacts
URL: https://api.iovox.com:444/Contacts?v=3&method=deleteContacts&contact_ids=100A,200B
The following parameters can be sent in the querystring
| Parameter | Description | Default Value | Data Type | Mandatory |
| v | API version to use | INTEGER | YES | |
| contact_ids | A comma delimited list of all contact ids of the contacts to be deleted | STRING | YES | |
| rm_rules | TRUE/FALSE. If set to TRUE and the contact's details form part of a custom Rule Template the Template will be deleted and removed from any Links it is attached to. Also, if the contact's details have been used to fix a variable rule the related template will be detached from any Links using these details. If set to FALSE and the contact's details are used in a Rule Template or to fix a variable Rule, an error will be thrown | FALSE | BOOLEAN | NO |
| rm_if_user | TRUE/FALSE. If set to TRUE and the contact has a user account then the user will also be removed. If set to FALSE and the contact has a user account, an error will be thrown | FALSE | BOOLEAN | NO |
Result¶
Error Result¶
| HTTP Code | Error String | Resolution |
| 400 | API Version Empty | Add a value for the v parameter in the query string |
| 400 | API Version Invalid | Correct v parameter |
| 400 | Request Method must be DELETE. x attempted | Switch request method x to DELETE |
| 400 | Remove If User Invalid | Correct rm_if_user to be TRUE or FALSE, or remove parameter to default to FALSE |
| 400 | Contact IDs Empty | Add one or more contact_ids to the request |
| 400 | Contact ID x of y does not exist | Correct contact_id x (item) of y (total) to a contact_id that exists |
| 400 | Contact x of y is used in Rules or Rule Templates | Remove contact_id x (item) of y (total) or change rm_rules to TRUE |
| 400 | Contact x of y has a user account | Remove contact_id x (item) of y (total) or change rm_if_user to TRUE |
| 500 | Internal Server Error | Retry later |