Task object allows users to manage Tasks associated with various entities in Maximizer CRM.

A Task is a scheduled action, assigned to a user to manage customer interactions and track progress. Tasks can be associated with Opportunities, Campaigns, Cases, AbEntries or Leads.

Below are some considerations for Tasks:

Some fields like Priority, Category, Result or Activity can be customized and have multiple available options. Check the field options to see the available ones.
To tie a Task to an AbEntry, set the AbEntryKey field with the key of the related AbEntry.
To tie a Task to a Lead, set the LeadKey field with the key of the related Lead.
To tie a Task to an Opportunity, set the WithKey field with the key of the related Opportunity. Additionally, ensure that either AbEntryKey or LeadKey is set, depending on whether the Opportunity is tied to an AbEntry or a Lead.
To tie a Task to a Case or Campaign, set the WithKey field with the key of the related Case or Campaign as applicable.

HowTo's

Create - Task For Lead

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "Task": {
        "Data": {
            // Key of the lead the Task will be associated to
            "LeadKey": "TGVhZAkyNDEyMTkwMDAwMDAxNjQwMzc5MDJMRQkw",
            // Could be "Call", "Send Email", "Follow-up". Check fieldOptions for more
            "Activity": "Call",
            // Check fieldoptions
            "Category": [
                "1"
            ],
            // Check fieldoptions
            "Result": [
                "2"
            ],
            "Completed": false,
            "AssignedTo": null,
            // Could be HI, LOW or MED. Check fieldOptions
            "Priority": "LOW",
            "DateTime": "2025-01-01"
        }
    }
}

Create - Task For Campaign

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "Task": {
        "Data": {
            // Associate Task to a Campaign
            "WithKey": "Q2FtcGFpZ24JMjQxMjE3MDAwMDAwMzk3NDYyNTc0ME0JMA==",
            // Could be "Call", "Send Email", "Follow-up". Check fieldOptions for more
            "Activity": "Call",
            // Check fieldoptions
            "Category": [
                "1"
            ],
            // Check fieldoptions
            "Result": [
                "2"
            ],
            "Completed": true,
            "AssignedTo": null,
            // Could be HI, LOW or MED. Check fieldOptions
            "Priority": "LOW",
            "DateTime": "2025-01-01"
        }
    }
}

Create - Task For Opportunity

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "Task": {
        "Data": {
            // Associate Task to a Opportunity
            "WithKey": "T3Bwb3J0dW5pdHkJMjQxMjE3MjUxMjM0MTg5NjEwMDMxTwkw",
            // AbEntryKey should be provided when creating a task for opportunity
            "AbEntryKey": "QWJFbnRyeQkyNDEyMTcyNTEyMzIwNTUyNTAwMjVDCTA=",
            // Could be "Call", "Send Email", "Follow-up". Check fieldOptions for more
            "Activity": "Call",
            // Check fieldoptions
            "Category": [
                "1"
            ],
            // Check fieldoptions
            "Result": [
                "2"
            ],
            "Completed": true,
            "AssignedTo": null,
            // Could be HI, LOW or MED. Check fieldOptions
            "Priority": "LOW",
            "DateTime": "2025-01-01"
        }
    },
    "Compatibility": {
        "AbEntryKey": "2.0"
    }
}

Read - Count Overdue Tasks By Contact

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Task": {
        "Scope": {
            "Fields": {
                "$COUNT(Key)": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "$AND": [
                    {
                        "Completed": {
                            "$EQ": false
                        }
                    },
                    {
                        // Key of the contact to search tasks for
                        "AbEntryKey": {
                            "$EQ": "QWJFbnRyeQkyMjA1MDUyNTIyMjczODY2NDAwMjlDCTE="
                        }
                    },
                    {
                        // All tasks with date Lower Than Today
                        "DateTime": {
                            "$LT": "$TODAY()"
                        }
                    }
                ]
            }
        }
    },
    "Compatibility": {
        "AbEntryKey": "2.0"
    },
    // Required for using $LT operator
    "Configuration": {
        "Drivers": {
            "ITaskSearcher": "Maximizer.Model.Access.Sql.TaskSearcher"
        }
    }
}

Read - List of Overdue Tasks By Contact

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Task": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "AssignedTo": 1,
                "DateTime": 1,
                "Priority": 1,
                "Completed": 1,
                "Activity": 1,
                "AbEntryKey": 1,
                "LeadKey": 1,
                "WithKey": 1,
                "Result": 1,
                "Category": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "$AND": [
                    {
                        "Completed": {
                            "$EQ": false
                        }
                    },
                    {
                        // Key of the contact to search tasks for
                        "AbEntryKey": {
                            "$EQ": "QWJFbnRyeQkyMjA1MDUyNTIyMjczODY2NDAwMjlDCTE="
                        }
                    },
                    {
                        // All tasks with date Lower Than Today
                        "DateTime": {
                            "$LT": "$TODAY()"
                        }
                    }
                ]
            }
        },
        "OrderBy": {
            "Fields": {
                "DataTime": "DESC"
            }
        }
    },
    "Compatibility": {
        "AbEntryKey": "2.0"
    },
    // Required for using $LT operator
    "Configuration": {
        "Drivers": {
            "ITaskSearcher": "Maximizer.Model.Access.Sql.TaskSearcher"
        }
    }
}

Read - Count Upcoming Tasks By Contact

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Task": {
        "Scope": {
            "Fields": {
                "$COUNT(Key)": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "$AND": [
                    {
                        "Completed": {
                            "$EQ": false
                        }
                    },
                    {
                        // Key of the contact to search tasks for
                        "AbEntryKey": {
                            "$EQ": "QWJFbnRyeQkyMjA1MDUyNTIyMjczODY2NDAwMjlDCTE="
                        }
                    },
                    {
                        // All tasks with date Greater Than Today
                        "DateTime": {
                            "$GT": "$TODAY()"
                        }
                    }
                ]
            }
        }
    },
    "Compatibility": {
        "AbEntryKey": "2.0"
    },
    // Required for using $GT operator
    "Configuration": {
        "Drivers": {
            "ITaskSearcher": "Maximizer.Model.Access.Sql.TaskSearcher"
        }
    }
}

Read - List of Upcoming Tasks By Contact

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Task": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "AssignedTo": 1,
                "DateTime": 1,
                "Priority": 1,
                "Completed": 1,
                "Activity": 1,
                "AbEntryKey": 1,
                "LeadKey": 1,
                "WithKey": 1,
                "Result": 1,
                "Category": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "$AND": [
                    {
                        "Completed": {
                            "$EQ": false
                        }
                    },
                    {
                        // Key of the contact to search tasks for
                        "AbEntryKey": {
                            "$EQ": "QWJFbnRyeQkyMjA1MDUyNTIyMjczODY2NDAwMjlDCTE="
                        }
                    },
                    {
                        // All tasks with date Greater Than Today
                        "DateTime": {
                            "$GT": "$TODAY()"
                        }
                    }
                ]
            }
        },
        "OrderBy": {
            "Fields": {
                "DataTime": "ASC"
            }
        }
    },
    "Compatibility": {
        "AbEntryKey": "2.0"
    },
    // Required for using $GT operator
    "Configuration": {
        "Drivers": {
            "ITaskSearcher": "Maximizer.Model.Access.Sql.TaskSearcher"
        }
    }
}

MetaData

Read Task metadata (simple)

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Schema": {
        "Scope": {
            "Fields": 1
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/Task"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

Read Task metadata (more)

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Schema": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "Alias": 1,
                "Type": 1,
                "Name": 1,
                "AppliesTo": 1,
                "Sortable": 1,
                "Queryable": 1,
                "Mandatory": 1,
                "Attributes": 1,
                "DisplayValue": 1
            }
        },
        "Criteria": {
            "SearchQuery": {
                "Key": {
                    "$TREE": "/Task"
                }
            }
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

FieldOptions

Read Task FieldOptions - Priority

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Task": {
        "FieldOptions": {
            "Priority": [
                {
                    "Key": 1,
                    "DisplayValue": 1
                }
            ]
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

Read Task FieldOptions - Activity

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Task": {
        "FieldOptions": {
            "Activity": [
                {
                    "Key": 1,
                    "DisplayValue": 1
                }
            ]
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

Read Task FieldOptions - Result

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Task": {
        "FieldOptions": {
            "Result": [
                {
                    "Key": 1,
                    "DisplayValue": 1
                }
            ]
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

Read Task FieldOptions - Category

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Task": {
        "FieldOptions": {
            "Category": [
                {
                    "Key": 1,
                    "DisplayValue": 1
                }
            ]
        }
    },
    "Compatibility": {
        "SchemaObject": "1.0"
    }
}

Task CRUD

Create - Task

// POST https://api.maximizer.com/octopus/Create
// Authorization: Bearer <token>
{
    "Task": {
        "Data": {
            "Key": null,
            // Task associated to an AbEntry
            "AbEntryKey": "Q29udGFjdAkyMjA1MDUyNTIyMjczODY2NDAwMjlDCTE=",
            "DateTime": "2025-01-01",
            "Alarm": "2025-01-01",
            "SnoozeUntil": "2025-01-01",
            // Check field options to see Priority available options
            "Priority": "Hi",
            "Completed": false,
            // Check field options to see Category available options
            "Category": [
                "1"
            ],
            // Check field options to see Result available options
            "Result": [
                "2"
            ],
            // Check field options to see Activity available options
            "Activity": "Call",
            // Used to assign the task to the particular user
            "AssignedTo": null
        }
    },
    "Compatibility": {
        "AbEntryKey": "2.0"
    }
}

Read - Task

// POST https://api.maximizer.com/octopus/Read
// Authorization: Bearer <token>
{
    "Task": {
        "Scope": {
            "Fields": {
                "Key": 1,
                "AssignedTo": 1,
                "DateTime": 1,
                "Alarm": 1,
                "SnoozeUntil": 1,
                "Priority": 1,
                "Completed": 1,
                "Activity": 1,
                "WithKey": 1,
                "LeadKey": 1,
                "AbEntryKey": 1
            }
        },
        "Criteria": {
            "SearchQuery": {},
            "Top": 3
        }
    },
    "Compatibility": {
        "AbEntryKey": "2.0"
    },
    // Required for using Top in Criteria
    "Configuration": {
        "Drivers": {
            "ITaskSearcher": "Maximizer.Model.Access.Sql.TaskSearcher"
        }
    }
}

Update - Task

// POST https://api.maximizer.com/octopus/Update
// Authorization: Bearer <token>
{
    "Task": {
        "Data": {
            "Key": "VGFzawkzNQ==", // Mandatory
            "DateTime": "2025-01-01",
            "SnoozeUntil": "2025-01-01",
            "Priority": "Hi",
            "Completed": true,
            "IconType": 1,
            "Activity": "Test Task Phrase search Updated"
        }
    }
}

Delete - Task

// POST https://api.maximizer.com/octopus/Delete
// Authorization: Bearer <token>
{
    "Task": {
        "Data": {
            "Key": "VGFzawkzNQ==" // Mandatory
        }
    }
}