Tasks

Update Task

Updates one or more fields on a task. Only include the fields you want to change.

Unassigning users:

Set assigned_to_id to null to unassign all users
Use unassign_user with a user ID to remove a specific user

Moving tasks between columns:

Set status to a column name (e.g. todo, doing, or a custom column name)
Set status to feedback to return the task to the Feedback panel

Audit trail: Include updater_email to attribute the change to a specific user. This is for audit purposes only - permissions are not enforced via the API.

put/api_v2/projects/{project_id}/tasks/{task_id}.json

Request

Base URL: https://www.bugherd.com
URL: https://www.bugherd.com/api_v2/projects/{project_id}/tasks/{task_id}.json
Auth: HTTP basic

Path parameters

project_idinteger required

task_idinteger required

Request body

Response

Updated task

Example response

{
  "task": {
    "id": 98765,
    "local_task_id": 42,
    "project_id": 1000,
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z",
    "title": "Button not aligned on mobile",
    "description": "The submit button overlaps the footer on screens under 375px.",
    "status": "todo",
    "status_id": 1,
    "priority": "normal",
    "priority_id": 3,
    "site": "https://www.example.com",
    "url": "/checkout",
    "tag_names": [
      "ui",
      "mobile"
    ],
    "external_id": "JIRA-123",
    "requester_email": "reporter@example.com",
    "attachments": [],
    "screenshot_url": "https://bugherd.com/screenshots/abc.png",
    "secret_link": "https://bugherd.com/tasks/secret/abc123",
    "admin_link": "https://bugherd.com/projects/1000/tasks/42",
    "assigned_to": {
      "id": 4561,
      "email": "jane@example.com",
      "display_name": "Jane Smith",
      "avatar_url": "https://bugherd.com/avatars/jane.png"
    },
    "requester": {
      "id": 4561,
      "email": "jane@example.com",
      "display_name": "Jane Smith",
      "avatar_url": "https://bugherd.com/avatars/jane.png"
    },
    "project_name": "BugHerd",
    "assignee_ids": [],
    "assignees": [
      {
        "id": 4561,
        "email": "jane@example.com",
        "display_name": "Jane Smith",
        "avatar_url": "https://bugherd.com/avatars/jane.png"
      }
    ],
    "requester_id": 851,
    "updater": {
      "id": 4561,
      "email": "jane@example.com",
      "display_name": "Jane Smith",
      "avatar_url": "https://bugherd.com/avatars/jane.png"
    },
    "metadata": {
      "rails_page": "pages#home",
      "user_id": "851"
    },
    "screenshot_data": {
      "screenshot_width": 1214,
      "screenshot_height": 1214,
      "screenshot_pin_x": 633,
      "screenshot_pin_y": 514
    },
    "requester_os": "Mac",
    "requester_browser": "Chrome 26",
    "requester_browser_size": "1214 x 806 px",
    "requester_resolution": "1440 x 900 px",
    "selector_info": {
      "path": "html>body...",
      "html": "<img...>",
      "version": 2
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.