RunActionSet

Overview

Run an Action Set on a contact in the database via an http form post.

Post Url

https://www.allclients.com/api/2/RunActionSet.aspx
  • SSL is requred
  • White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.

Important Notes

For an Action Set “Email” action, the contact must have a valid, opted-in email address.

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
teammemberid No Must be numeric. Team Member ID. Defaults to 0 (Account Owner).   Action Set will be “Run As” as if this user was executing the Action Set.
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
actionsetid Conditional Either actionsetid or actionsetname is required to identify the Action Set to run
actionsetname Conditional  Either actionsetid or actionsetname is required to identify the Action Set to run
startdatetime No Defaults to current day. Use US format MM/DD/YYYY  hh:mm AM/PM, server time, which is US Central TimeExamples:

4/15/2021 10:00 AM
12/30/2023 6:15 PM

Please note that start times are not exact due to server load.

* 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>Action Set completed</details>
</results>

Sample Failure Messages

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