Overview
Delete a “Flag” from settings based on information sent via an http form post.
Post Url
https://www.allclients.com/api/2/DeleteFlag.aspx
- SSL is requred
- White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.
Form Fields
Field | Max Length* | Required | Notes |
response_type | No | Default results will be returned in XML. Set this field value to json to return results in JSON format | |
accountid | Yes | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
flagid | Yes | ID of the flag to delete | |
removeifused | 1 | Yes |
Set value to “1” to remove this flag even when it is assigned to contacts. Set value to “0” and the flag will NOT be removed if it is assigned to any contacts. |
Sample Results
Success Message
<?xml version="1.0"?>
<results>
<message>Success</message>
<flagid>15631</flagid>
</results>
Sample Failure Message
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>
<?xml version="1.0"?>
<results>
<error>Flag is in use</error>
</results>