Planfix API contact.delete: Difference between revisions

From Planfix
Jump to: navigation, search
(Created page with "This function allows you to delete a contact. Execution of this function requires appropriate permissions. Request format: <source lang="xml"> <?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> </source> {| class="wikitable" style="margin-top: 1em; width:100% " !width="150"|Name !!width="200"|...")
 
 
Line 55: Line 55:
== Go To ==
== Go To ==
*[[Planfix API:Contacts]]
*[[Planfix API:Contacts]]
*[[Error codes]]
*[[Error codes XML API v1|Error codes]]
*[[List of functions]]
*[[List of functions]]

Latest revision as of 09:25, 6 March 2024

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