Overview
Lists Flags for an account based on information sent via an http form post.
Post Url
https://www.allclients.com/api/2/GetFlags.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 | |
flagid | No | If you would like to just return one flag, set this field value to the corresponding flag id. | |
apikey | Yes | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel |
Sample Results
Success Message
<results>
<flags>
<flag>
<flagid>10001</flagid>
<accountid>2</accountid>
<name>Hot Prospect</name>
<imageurl>http://www.allclients.com/images/flags/flag_red.png</imageurl>
</flag>
<flag>
<flagid>10002</flagid>
<accountid>2</accountid>
<name>Past Customer</name>
<imageurl>http://www.allclients.com/images/flags/money.png</imageurl>
</flag>
</flags>
</results>
Sample Failure Message
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>