The task object holds information about a task, like who it is assigned to. You can retrieve a specific task, as well as list all tasks.
Attributes
id string
id stringUnique identifier for the object.
Reference object
Reference objectIdentifies the partner by ID and custom values.
View child attributes
PartnerId integer
PartnerId integerUnique identifier for the partner.
PartnerValue1 string
PartnerValue1 stringUnique custom value assigned to this partner (). Learn more.{mp_value_1}
PartnerValue2 string
PartnerValue2 stringUnique custom value assigned to this partner (). Learn more.{mp_value_2}
PartnerValue3 string
PartnerValue3 stringUnique custom value assigned to this partner (). Learn more.{mp_value_3}
Details object
Details objectView child attributes
Summary string
Summary stringTitle of the request.
Description string
Description stringDescription of the task.
Urgent boolean
Urgent booleanWhether this task is considered urgent or not.
State enum
State enumThe current state of the task.
| Possible enum values |
|---|
NEW |
INPROGRESS |
DUPLICATE |
INVALID |
BLOCKED |
COMPLETED |
APPROVED |
Type enum
Type enum| Possible enum values |
|---|
COMPLIANCE |
TECHNICAL |
GENERAL |
CREATIVE |
FINANCE |
CONTRACTS |
ANALYTICS |
SEARCH_ENGINE_MONITORING |
SubtypeId integer
SubtypeId integerUnique identifier for the subtype.
SubtypeName string
SubtypeName stringName of the task subtype.
ResolutionId
ResolutionIdUnique identifier for the resolution.
ResolutionName
ResolutionNameName of the resolution.
Attachments array of objects
Attachments array of objectsDetails about each attachment.
View child attributes
Id string
Id stringUnique identifier for the object.
Filename string
Filename string
Name of the file attached, including the file extension.
Location string
Location string
The publicly accessible URL to download the file.
DueDate datetime
DueDate datetimeDate and time at which the task is due. Displayed in ISO 8601 format.
AssigneeUser object
AssigneeUser objectView child attributes
Username string
Username stringName of the user of the partner account that the task is assigned to.
EmailAddress string
EmailAddress stringEmail address of the user of the partner account that the task is assigned to.
AssigneeAccount string
AssigneeAccount stringName of the partner account that the task is assigned to.
TotalActions integer
TotalActions integerTotal number of actions that have been recorded for this task.
Actions array of objects
Actions array of objectsDescribes actions that have occurred on this task.
TotalComments integer
TotalComments integerTotal number of comments that have been recorded for this task.
Comments array of objects
Comments array of objectsDetails about each comment on this task.
View child attributes
Id integer
Id integer
Unique identifier for the comment object.
Comment string
Comment string
The content of the comment.
Commenter string
Commenter string
Name of the commenter.
Attachments array of objects
Attachments array of objects
DateCreated datetime
DateCreated datetimeThe date and time the comment was created.
DateLastUpdated datetime
DateLastUpdated datetimeThe date and time the task was last updated.
CreatedBy object
CreatedBy objectView child attributes
Username integer
Username integerName of the user that created the task.
EmailAddress string
EmailAddress stringEmail address of the user that created the task.
LastUpdatedBy object
LastUpdatedBy objectView child attributes
Username integer
Username integerName of the user that last updated the task.
EmailAddress string
EmailAddress stringEmail address of the user that last updated the task.
{
"Id": "3562529",
"Reference": "",
"Details": {
"Summary": "Acme Rewards Card Update",
"Description": "The Acme Rewards Card APR has changed, please update your ads to reflect this new value.",
"Urgent": true,
"State": "INPROGRESS",
"Type": "COMPLIANCE",
"SubtypeId": "",
"SubtypeName": "",
"ResolutionId": "",
"ResolutionName": ""
},
"Attachments": [
{
"Id": "task_1223456_988957a0-e0ed-4f16-984b-f5a9259e6be7",
"Filename": "acme_reward_card_details.pdf",
"Location": "https://cdn.example.com/task_123456_988957a0-e0ed-4f16-984b-f5a9259e6be7.pdf"
}
],
"DueDate": "2021-08-31T04:00:00.000+0000",
"AssigneeUser": {
"Username": "Wile E. Coyote",
"EmailAddress": "[email protected]"
},
"AssigneeAccount": "Acme Partners",
"TotalActions": "0",
"Actions": "",
"TotalComments": "1",
"Comments": [
{
"Id": "98765",
"Comment": "I've updated our home page with the latest ads, see attached screenshot.",
"Commenter": "Wile E. Coyote",
"Attachments": [
{
"Id": "comment_987654_ccbef408-9312-440a-8a8a-6b58ce9c0492",
"Filename": "coyote_partner_homepage.jpg",
"Location": "https://cdn.impactradius-content.com/comment_987654_ccbef408-9312-440a-8a8a-6b58ce9c0492.jpg"
}
]
}
],
"DateCreated": "2021-08-18T16:47:21.000+0000",
"DateLastUpdated": "2021-08-18T22:45:42.000+0000",
"CreatedBy": {
"Username": "Acme.Road.Runner",
"EmailAddress": "[email protected]"
},
"LastUpdatedBy": {
"Username": "Acme.Road.Runner",
"EmailAddress": "[email protected]"
}
}