AssignToDoPlan

Overview

Assign an To-Do Plan to a contact in the database via an http form post.

URL

POST/api/2/AssignToDoPlan.aspx

Parameters

FieldMax LengthRequiredNotes
response_typefalseDefault results will be returned in XML.
Set this field value to json to return results in JSON format
accountidtrueMust be numeric. Account ID for this account. Found in Settings > API Settings or for White Label CRM in the Admin control panel
apikeytrueAPI Key for this account.
Found in Settings > API Settings or for White Label CRM in the Admin control panel
identifymethod1trueValues:

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)
identifyvalue75trueValue changes based on identifymethod.
Must be integer if contactid, otherwise must be an email address on file
todoplanid50trueSpecify either the internal ID of the To Do Plan or the name of the To Do Plan.
defaultassign50falseSpecify "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"
offsetdays5false# 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)