tasks.statuses.add

Apps » Teamwork API »

Adds a new task status. Full access to Teamwork is required.

Parameters

  • name POST

    Status name.

  • button POST

    Caption on the button which will be used to transfer tasks to the new status.

  • assign POST Optional

    The user to whom the task must be assigned when transferred to this status: 'author' (who created the task), 'user' (a specified user), 'select' (offer the selection of a user to the one who changes the task status), '' (keep the the assigned user selection unchanged).

  • assign_user POST Optional

    ID of the user to whom the task must be assigned if the “assign” parameter contains value 'user'.

  • allow_clear_assign POST Optional

    Flag denoting whether it is allowed to transfer the task to this status without assignment to any user.

  • button_color POST Optional

    HTML color value for the button background.

  • title_color POST Optional

    HTML color value for the button text.

  • allow_comment POST Optional

    Flag denoting the possibility to add comments to tasks in this status.

  • sort POST Optional

    Sort value for the status list (integer).

  • format GET Optional

    Sets response format. Available options: json (default), xml.

Return value

Array with the following keys:

  • id int Status ID.
  • name string Status name.
  • button string Caption on the button which will be used to transfer tasks to the new status.
  • sort int Sort value.
  • params array Additional parameters as an array with the following keys:
  • params['allow_clear_assign'] bool Flag denoting whether it is allowed to transfer the task to this status without assignment to any user.
  • params['allow_comment'] bool Flag denoting the possibility to add comments to tasks in this status.
  • params['assign'] string|null The user to whom the task must be assigned when transferred to this status: 'author' (who created the task), 'user' (a specified user), 'select' (offer the selection of a user to the one who changes the task status), '' (keep the the assigned user selection unchanged).
  • params['assign_user'] int|null ID of the user to whom the task must be assigned if the assign parameter contains value 'user'.
  • params['button_color'] string|null HTML color value for the button background.
  • params['title_color'] string|null HTML color value for the button text.