Overview
Assign an To-Do Plan to a contact in the database via an http form post.
Post Url
https://www.allclients.com/api/2/AssignToDoPlan.aspx
- SSL is requred
- White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.
Important Notes
Contact’s email must be “Opt In” before an Autoresponder can be assigned
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 |
| todoplanid or todoplanname |
50 | Yes | Specify either the internal ID of the To Do Plan or the name of the To Do Plan. |
| defaultassign | 50 | No | Specify “owner” if you would like the To-Dos to be assigned to the contact owner in cases where the To Do Plan item is set to “(Default) The user that assigns this To Do Plan” |
| offsetdays | 5 | No | # of days to offset the due date for each item in the To Do Plan. (Negative numbers will subtract from the “days” value for each item). A value of “-7” will calculate the “start date” for a week ago. A value of “30” will calculate the start date for 30 days from today. (0 is default) |
* 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>To-Do Plan assigned</details>
</results>
Sample Failure Messages
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>
