Overview
Lists To-Do Plans for an account based on information sent via an http form post.
Post Url
https://www.allclients.com/api/2/GetToDoPlans.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 |
Sample Results
Success Message
<?xml version="1.0"?>
<results>
<todoplans>
<todoplan>
<id>10001</id>
<accountid>2</accountid>
<name>Test Autoresponders 1</name>
<steps>
<step>
<stepid>242</stepid>
<summary>This is a To Do Plan Item</summary>
<increment>D</increment>
<period>3</period>
<category>phone call</category>
<emailtemplateid>0</emailtemplateid>
<lettertemplateid>0</lettertemplateid>
</step>
</steps>
</todoplan>
</todoplans>
</results>
<category> possible values: “no category”, “email”, “letter”, “phone call”
Sample Failure Message
<?xml version="1.0"?>
<results>
<error>Authentication failed</error>
</results>