Planfix API contact.delete

From Planfix
Jump to: navigation, search

This function allows you to delete a contact. Execution of this function requires appropriate permissions. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.delete">
  <account></account>
  <sid></sid>
  <contact>
    <id></id>
    <userid></userid>
    <general></general>
  </contact>
  <signature></signature>
</request>
Name Type Value Note
id int contact identifier
signature string(32) signature


Result of successful function execution:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <contact>
    <id></id>
  </contact>
</response>
Name Type Value Note
id int contact identifier
userid int contact identifier for cases when it is used in the system on par with employees (task assignee, etc., as well as a custom field of the contact type)
general int contact number


Otherwise, an error response will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>


Go To