API reference
All operations
TASK

Updates an existing task by its ID.

PUT/api/v2/tasks/{task-id}

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

task-idpathstringrequired

Request body

application/jsonrequired

The updated task data.

UpdateTaskRequest
  • taskIdinteger · int32
  • userIDinteger · int32
  • companyIDinteger · int32
  • contactIDinteger · int32
  • relatedRecordIDinteger · int32
  • relatedRecordTypestringnullable
  • relatedTostringnullable
  • subRelatedRecordTypestringnullable
  • subRelatedRecordIdinteger · int32nullable
  • subjectstringnullable
  • commentsstringnullable
  • dueDatestring · datenullable
  • statusstringnullable
  • prioritystringnullable
  • reminderboolean
  • utcReminderDatestring · date-timenullable

Responses

Task updated successfully.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

dataTaskDto
  • taskIdinteger · int32
  • companyIdinteger · int32
  • companyNamestringnullable
  • userIdinteger · int32
  • ownerstringnullable
  • contactIdinteger · int32
  • contactstringnullable
  • relatedRecordIdinteger · int32
  • relatedRecordTypestringnullable
  • relatedTostringnullable
  • subjectstring
  • commentsstringnullable
  • dueDatestring · date
  • completeDatestring · date-timenullable
  • statusstringnullable
  • businessStepstring
  • prioritystringnullable
  • reminderboolean
  • reminderRepeatSchedulestring
  • utcReminderDatestring · date-timenullable
  • reminderDatestring · date-timenullable
  • createdstring · date-timenullable
  • lastModifiedstring · date-timenullable
  • enteredBystringnullable
  • modifiedBystringnullable
  • deletedboolean
  • eventIdstring
  • calendarIdstring