v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Task

Update Task

Update a Task given the Task identifier and Task data.

put/communications/tasks/{task_id}

Path parameters

task_idstring required

task id

Headers

x-api-keystring required

A valid api key. If you don't have one, please request one through the Web Integration screen.

Request body

task_namestring

Name of task

task_descriptionstring

Description of the task

due_datestring date

Day this task is due

Example request

{
  "assignee": {
    "object_type_id": 1234567891234567,
    "id": 1234567891234567
  },
  "due_date": "2014-12-31",
  "recurrence": {
    "repeat_every_unit_id": 1234567891234567,
    "ends_on_date": "2014-12-31",
    "next_occurrence": "2014-12-31"
  }
}

Response

Task id created

task_idstring required

task_id created

task_namestring required

Name of task

task_descriptionstring

Description of the task

due_datestring date

Day this task is due

Example response

{
  "assignee": {
    "object_type_id": 1234567891234567,
    "id": 1234567891234567
  },
  "due_date": "2014-12-31",
  "recurrence": {
    "repeat_every_unit_id": 1234567891234567,
    "ends_on_date": "2014-12-31",
    "next_occurrence": "2014-12-31"
  },
  "completed": {
    "object_type_id": 1234567891234567,
    "completed_by_id": 1234567891234567,
    "completed_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "created": {
    "object_type_id": 1234567891234567,
    "created_by_id": 1234567891234567,
    "created_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "updated": {
    "object_type_id": 1234567891234567,
    "updated_by_id": 1234567891234567,
    "updated_on_datetime": "2014-12-31T23:59:59.938Z"
  }
}