Run an Action Set (Workflow) on a contact in the database via an http form post.
Field | Max Length | Required | Notes |
---|---|---|---|
response_type | false | Default results will be returned in XML. Set this field value to json to return results in JSON format | |
accountid | true | Must be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
apikey | true | API Key for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel | |
teammemberid | false | 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 | true | 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 | true | Value changes based on identifymethod 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 | false | Defaults to current day. Use US format MM/DD/YYYY hh:mm AM/PM, server time, which is US Central Time Examples: 4/15/2021 10:00 AM 12/30/2023 6:15 PM Please note that start times are not exact due |