Update Task
Use this operation to update any of the writable fields of an existing Task object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL.
Parameters
Body Params | |
---|---|
JSON: | json |
XML: | string |
Path Params | |
---|---|
yourCompany: | string |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
{
"Tasks": {
"Task": [{
"TaskId": "3422",
"Subject": "Test New Task",
"StartDate": "01-24-2020",
"StartTime": "05:47:00",
"DueDate": "01-25-2020",
"AccountName": "Account1",
"ContactName": "Contact1",
"RelatedToType": "Accounts",
"RelatedToValue": "Account1",
"Status": "In Progress",
"SendNotification": "No",
"ActivityType": "Task",
"Priority": "High",
"CreatedTime": "01-24-2020 05:51:01",
"ModifiedTime": "01-24-2020 05:53:00",
"Description": "The Description Goes here.",
"TaskCustomFields": {
"CustomField": [{
"Name": "CustomFied1",
"Value": "Custom info 1"
},
{
"Name": "CustomFied2",
"Value": "Custom info 2"
}
]
}
}]
}
}
<Tasks>
<Task>
<TaskId>3422</TaskId>
<Subject>Test New Task</Subject>
<StartDate>01-24-2020</StartDate>
<StartTime>05:47:00</StartTime>
<DueDate>01-25-2020</DueDate>
<AccountName>Account1</AccountName>
<ContactName>Contact1</ContactName>
<RelatedToType>Accounts</RelatedToType>
<RelatedToValue>Account1</RelatedToValue>
<Status>In Progress</Status>
<SendNotification>No</SendNotification>
<ActivityType>Task</ActivityType>
<Priority>High</Priority>
<CreatedTime>01-24-2020 05:51:01</CreatedTime>
<ModifiedTime>01-24-2020 05:53:00</ModifiedTime>
<Description>The Description Goes here.</Description>
<TaskCustomFields>
<CustomField>
<Name>CustomFied1</Name>
<Value>Custom info 1</Value>
</CustomField>
<CustomField>
<Name>CustomFied2</Name>
<Value>Custom info 2</Value>
</CustomField>
</TaskCustomFields>
</Task>
</Tasks>
Sample Response
{
"MCM": {
"response": {
"objectType": "Task",
"syncTime": "2021-06-10 03:23:14"
},
"parameters": {
"results": {
"message": {
"status": "Success",
"success_message": {
"task_subject": "Test New Task",
"task_id": "203060"
}
}
}
}
}
}
<MCM>
<response>
<objectType>Task</objectType>
<syncTime>2021-06-10 03:23:14</syncTime>
</response>
<parameters>
<results>
<message>
<status>Success</status>
<success_message>
<task_subject>Test New Task</task_subject>
<task_id>203060</task_id>
</success_message>
</message>
</results>
</parameters>
</MCM>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Task">
<method name="PUT">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="TaskId" type="xsd:string" style="body" required="true"/>
<param name="Subject" type="xsd:string" style="body" required="true"/>
<param name="StartDate" type="xsd:date" style="body" required="true"/>
<param name="StartTime" type="xsd:time" style="body" required="true"/>
<param name="DueDate" type="xsd:date" style="body"/>
<param name="AccountName" type="xsd:string" style="body"/>
<param name="ContactName" type="xsd:string" style="body"/>
<param name="RelatedToType" type="xsd:string" style="body"/>
<param name="RelatedToValue" type="xsd:string" style="body"/>
<param name="Status" type="xsd:string" style="body"/>
<param name="SendNotification" type="xsd:string" style="body"/>
<param name="ActivityType" type="xsd:string" style="body"/>
<param name="Priority" type="xsd:string" style="body"/>
<param name="CreatedTime" type="xsd:dateTime" style="body"/>
<param name="ModifiedTime" type="xsd:dateTime" style="body"/>
<param name="Description" type="xsd:string" style="body"/>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet"/>
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error"/>
</response>
</method>
</resource>
</resources>
</application>
Updated about 20 hours ago