Hoshinplan

API Docs

PUT /tasks/:id
Update a task

Supported Formats

json, xml

Examples

curl -X PUT "https://www.hoshinplan.com/tasks/45544?app_key=<APP_KEY>&timestamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "status": "completed"
}'

Params

Param name Description
name
optional

Validations:

  • Must be a String
tsk_pos
optional

Used to sort the tasks in the hoshin view

Validations:

  • Must be a number.
lane_pos
optional

Used to sort the tasks in the kanban view

Validations:

  • Must be a number.
objective_id
optional

The id of the objective this task belongs to

Validations:

  • Must be a number.
responsible_id
optional

The id of the user that is responsible for this task

Validations:

  • Must be a number.
description
optional

Validations:

  • Must be a String
deadline
optional

Validations:

  • Must be Date.
show_on_parent
optional

Show this task in the parent Hoshin

Validations:

  • Must be one of: true, false, 1, 0.
reminder
optional

Send email reminders to the owner when the deadline comes

Validations:

  • Must be one of: true, false, 1, 0.
feeling
optional

How you are feeling about completing this task as planned

Validations:

  • Must be one of: smile, wondering, sad.
status
optional

Validations:

  • Must be one of: backlog, active, completed, discarded, deleted.

Respuesta

Code: 200

Description:

The updated task

Param name Description
id
optional

Validations:

  • Must be a number.
name
optional

Validations:

  • Must be a String
original_deadline
optional

Validations:

  • Must be Date.
created_at
optional

Validations:

  • Must be Date.
updated_at
optional

Validations:

  • Must be Date.
tsk_pos
optional

Used to sort the tasks in the hoshin view

Validations:

  • Must be a number.
lane_pos
optional

Used to sort the tasks in the kanban view

Validations:

  • Must be a number.
hoshin_id
optional

The id of the area this task belongs to

Validations:

  • Must be a number.
area_id
optional

The id of the area this task belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this task belongs to

Validations:

  • Must be a number.
creator_id
optional

The id of the user that created this task

Validations:

  • Must be a number.
objective_id
optional

The id of the objective this task belongs to

Validations:

  • Must be a number.
responsible_id
optional

The id of the user that is responsible for this task

Validations:

  • Must be a number.
description
optional

Validations:

  • Must be a String
deadline
optional

Validations:

  • Must be Date.
show_on_parent
optional

Show this task in the parent Hoshin

Validations:

  • Must be one of: true, false, 1, 0.
parent_objective_id
optional

The id of the parent objective of the objective this task belongs to

Validations:

  • Must be a number.
parent_area_id
optional

The id of the area of the parent objective of the objective this task belongs to

Validations:

  • Must be a number.
reminder
optional

Send email reminders to the owner when the deadline comes

Validations:

  • Must be one of: true, false, 1, 0.
feeling
optional

How you are feeling about completing this task as planned

Validations:

  • Must be one of: smile, wondering, sad.
status
optional

Validations:

  • Must be one of: backlog, active, completed, discarded, deleted.
deleted_at
optional

The date when this task was deleted

Validations:

  • Must be Date.