Tools and News for Developers using the AllClients Platform

ContactFlags

Overview

Update a contact in the database via an http form post.

Post Url

https://www.allclients.com/api/2/ContactFlags.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
identifymethod 1 Yes Values:

1 : By contactid (It’s recommended that you use this method and store our contactid in your system)

2 : By primary email on file. If there are multiple matches for the email address, we will choose the first one (by add date)

3: By email or other email on file.  If there are multiple matches for the email address, we will choose the first one (by add date)

identifyvalue 75 Yes Value changes based on indentifymethod. Must be integer if contactid, otherwise must be an email address on file
mode 1 Yes Values:

1 : Add Flag (If flag already exists for the contact, success will be reported)

2 : Remove Flag (If flag does not exist for the contact, sucess will be reported)

flag 50 Yes Must match flag “Name” exactly

* An error will not result if Max Length is exceeded. Data will be trimmed to this length. 

Sample Results

Success Messages

<?xml version="1.0"?>
<results>
    <message>Success</message>
    <details>Flag Added</details>
</results>


<?xml version="1.0"?>
<results>
    <message>Success</message>
    <details>Flag Removed</details>
</results>

Sample Failure Messages

<?xml version="1.0"?>
<results>
    <error>Authentication failed</error>
</results>