Feedback

Update feedback item

Updates one or more mutable fields on the feedback record, such as status, priority, assignee, or descriptive text. Only provided attributes are modified.

patch/v1/feedback/{id}

Request

  • Base URL: https://api.ybug.io
  • URL: https://api.ybug.io/v1/feedback/{id}
  • Auth: HTTP bearer

Request body

status_idinteger

New status identifier. Must be one of the team's statuses, as listed by GET /v1/projects/{projectId}/statuses; anything else is rejected with a 400 listing the ids the project accepts. Ids 1-5 are the built-in statuses (Open, In progress, Resolved, Closed, Backlog), custom statuses start at 100.

Feedback always has a status; it cannot be cleared with null.

priority_idinteger nullable

New priority identifier. Must be one of the priorities configured for the project; the ids in use are returned as priority_id on any feedback item.

Set to null to remove the priority.

type_idinteger nullable

New type identifier. Must be one of the types configured for the project; the ids in use are returned as type_id on any feedback item.

Set to null to remove the type.

assignee_idstring uuid nullable

Assign feedback to a project member by their user UUID.

Set to null to unassign.

titlestring

New feedback title (HTML tags will be stripped).

descriptionstring

New feedback description (HTML tags will be stripped).

Example request

{
  "status_id": 2,
  "priority_id": 3,
  "title": "Login form broken on Safari"
}

Response

Feedback successfully updated.

idstring
feedback_idinteger

Public shareable feedback identifier.

project_idstring
titlestring
reporterobject

Information about the feedback reporter.

urlstring uri
descriptionstring
ratinginteger nullable
rating_typestring nullable
net_promoter_scoreinteger nullable
priority_idinteger
prioritystring
type_idinteger
typestring
status_idinteger

The status of the feedback, as a status_id of the project's team. See the status_id request field on "Update feedback" for how the id ranges work.

statusstring
source_typestring
created_atstring date-time
updated_atstring date-time
comment_countinteger

Number of comments on this feedback item.

screenshot_urlstring uri nullable
video_urlstring uri nullable
console_log_urlstring uri nullable

Example response

{
  "id": "9xy12ab34c",
  "project_id": "ab12cd34ef56gh78ij90klmn",
  "title": "Login form broken",
  "assignee": {
    "id": "019a77e7-5105-774f-ac0b-1b9b18f8366a",
    "name": "Jana Nováková"
  },
  "user_data": {
    "plan": "PRO",
    "user_id": 123
  },
  "url": "https://app.example.com/login",
  "description": "When I click submit, nothing happens.",
  "rating_type": "csat",
  "priority_id": 3,
  "priority": "Medium",
  "type_id": 1,
  "type": "Bug",
  "status_id": 1,
  "status": "Open",
  "source_type": "widget",
  "comment_count": 3,
  "tags": [
    {
      "id": "019a77e7-5105-774f-ac0b-1b9b18f8366a",
      "name": "ui"
    }
  ],
  "custom_fields": [
    {
      "id": "018c2ba6-0d61-7d20-a9cb-0b7300294523",
      "name": "Custom text field",
      "value": "..."
    }
  ]
}

Changes

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