Hoshinplan

API Docs

PUT /areas/:id
Edit an area

Supported Formats

json, xml

Examples

curl -X PUT "https://www.hoshinplan.com/areas/32423?app_key=<APP_KEY>&timestamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "description": "The new description"
}'

Params

Param name Description
name
optional

Validations:

  • Must be a String
description
optional

Validations:

  • Must be a String
position
optional

Used to sort the areas in the hoshin view

Validations:

  • Must be a number.
color
optional

The color of the postits for this area in the kanban view

Validations:

  • Must be a String

Respuesta

Code: 200

Description:

The updated area

Param name Description
id
optional

Validations:

  • Must be a number.
name
optional

Validations:

  • Must be a String
description
optional

Validations:

  • Must be a String
created_at
optional

Validations:

  • Must be Date.
updated_at
optional

Validations:

  • Must be Date.
hoshin_id
optional

The id of the area this area belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this area belongs to

Validations:

  • Must be a number.
position
optional

Used to sort the areas in the hoshin view

Validations:

  • Must be a number.
creator_id
optional

The id of the user that created this area

Validations:

  • Must be a number.
color
optional

The color of the postits for this area in the kanban view

Validations:

  • Must be a String