Update a Task
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Updates a task. You can either pass the “OwnerId” or the “OwnerEmailAddress” in the JSON body to update the task owner.
API URL
URL
POST
https://{host}/v2/Task.svc/Update?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"UserTaskId":"04901f02-4d0c-11ec-993a-06f221480cd8",
"Name":"Document Collection",
"Description":"I'm assigning a new task",
"RelatedEntity":1,
"RelatedEntityId":"6f75b09d-0187-45d6-86dd-f848bd5a0aca",
"DueDate":"2022-10-10 10:11:23",
"Reminder":30,
"NotifyBy":"1100",
"OwnerId":"1a50c565-8525-11ea-a93b-0aa4c559f4ca"
}
Request Parameters
| Parameter | Description |
|---|---|
| UserTaskId | Unique Id of the task you want to update. You can find it using the Get Tasks API. |
| Name | Name of the task. |
| Description | Task description. |
| RelatedEntity | Pass “0” if you’re not passing any value to “RelatedEntityId” (which is the “LeadId” or “ProspectId”) ; Provide the value as “1” if you’re passing the “RelatedEntityId”. |
| RelatedEntityId | “LeadId” to which you want to associate the task. It will be considered only if “RelatedEntity” = “1”. You can obtain the “LeadId” through the Get Lead by Email API |
| DueDate | Due date of task in UTC (YYYY-MM-DD HH:MM:SS). |
| Reminder | Set a reminder in minutes. An email notification will be sent to task owner before the due time based on this setting. |
| NotifyBy | Set the value as 1100 if you want the task owner to be notified by email. Set the value as 1ooo if you don’t want any notifications. |
| OwnerId | UserId of the user you want to assign the task to. You can find it using the Get Users API. |
| OwnerEmailAddress | Email Address of the user you want to assign the task to (when “OwnerId” is not known). |
Response
200 OK
Content-Type: application/json
{
"Status":"Success",
"Message":{
"AffectedRows":1,
"AutoId":325
}
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
