Tools and News for Developers using the AllClients Platform

AddFlag

Overview

Adds a new “Flag” to settings based on information sent via an http form post.

(Adds the Flag to Settings > Flags. Function does not assign the flag to a contact)

Post Url

https://www.allclients.com/api/2/AddFlag.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
name 50 Yes Display name for the new flag
imagefilename 50 Yes Image filename.  Image location must point to an existing image in the images/flags/ folder.

See source HTML in Settings > Flags for available image filenames.

Only give the filename. Do not give any path or URLs information. Example: flag-blue.gif

color 1 No Background color for flag (Number 0-6).  Available options:

0: White (Default)
1: Red
2: Orange
3: Yellow
4: Green
5: Blue
6: Violet

 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&gtp>

<?xml version="1.0"?>
 <results>
     <error>Flag with this 'name' already exists</error>
 </results>