Task Object
The Task is a type of Activity in Order Time.
End Point
/task
GET, POST, PUT, DELETE
GET and DELETE requests expect parameter id of type Int32.
Properties
| Property | Caption | Data Type | Required |
| Subject | Subject | String (255) | True |
| TypeRef | Activity Type | EntityRef | True |
| AssignedToRef | Assigned To | EntityRef | True |
| StatusRef | Status | EntityRef | True |
| DueDate | Due Date | DateTime | True |
| Description | Description | String (4000) | False |
| ContactRef | Contact | EntityRef | False |
| RelatedToEntityType | Related To | RecordTypeEnum | False |
| RelatedToEntityRef | Related To | EntityRef | False |
| RelatedToDocType | Related To | RecordTypeEnum | False |
| RelatedToDocNo | Related To | Int32 | False |
| IsAlarmed | Alarm | Boolean | False |
| ReminderMinutes | Alarm | Int32 | False |
| Priority | Priority | 0 = Low 1 = Normal 2 = High 3 = Critical | False |
| CustomFields | Custom Fields | Array of CustomFieldData | False |
Json Sample
{
"Subject": "Make a call",
"TypeRef": { "Id": 2, "Name":"Task"},
"AssignedToRef": { "Id": 150, "Name":"Dean"},
"StatusRef": { "Id": 1, "Name":"Open"},
"DueDate": "2022-01-29T09:00:00",
"IsAlarmed": true,
"Priority": 2,
"ReminderMinutes": 15,
"Description": "See if he wants to order next week"
"RelatedToDocType": 7,
"RelatedToDocNo": 10698,
"CustomFields": [
{
"Name": "ActivityCust1",
"Value": "Pre-sale"
}
]
}
