USuserback
Feedback

Update a feedback

Changed on

Updates feedback

patch/feedback/{id}

Request

  • Base URL
    https://rest.userback.io/1.0
  • URL
    https://rest.userback.io/1.0/feedback/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Numeric feedback id, or a feedback key such as APP-123.

Example:APP-123

Numeric feedback id, or a feedback key such as APP-123

Request body

feedbackType'General' | 'Bug' | 'Idea' | 'Task'

The type of feedback that was given.

titlestring

The title provided by the user submitting the Feedback

descriptionstring

The description provided by the user submitting the Feedback

pageUrlstring uri

The url of the page where the feedback was submitted

isSharedboolean
allowPublicCommentboolean

If true, public comments are allowed to be posted on the feedback

priority'low' | 'neutral' | 'high' | 'urgent'
categorystring

If defined, the category the feedback was assigned to

ratingstring

Defines the rating given by the user submitting the feedback

assigneeIdinteger

ID is a generic type that is used to represent a unique identifier

dueDatestring

Define the due date of the feedback

notifyboolean

If set to false, notifications to Email, Instant Messengers and Auto-Reply will be supressed.

isPortalApprovedboolean

Portal visibility (publish / unpublish).

When changing from false to true: also sets feedbackType to Idea and isShared to true, and auto-votes the reporter (skipped for portal-created feedback). When changing from true to false: only clears portal approval (feedbackType and isShared are left unchanged).

Example request

{
  "title": "This button doesn't work",
  "pageUrl": "https://example.com",
  "category": "Bug",
  "assigneeId": 4455,
  "dueDate": "2024-02-30",
  "Workflow": {
    "id": 4455
  }
}

Response

Created

idinteger required

ID is a generic type that is used to represent a unique identifier

feedbackKeystring nullable

Public feedback key, for example APP-123. Usable in place of the numeric id on get, update, and delete. Null when the project has no key or this feedback has not been assigned one.

assigneeIdinteger

ID is a generic type that is used to represent a unique identifier

projectIdinteger required

ID is a generic type that is used to represent a unique identifier

feedbackType'General' | 'Bug' | 'Idea' | 'Task' required

The type of feedback that was given.

emailstring email required

The email of the user who submitted the Feedback

titlestring required

The title provided by the user submitting the Feedback

descriptionstring required

The description provided by the user submitting the Feedback

namestring required

The name of the user who submitted the Feedback

createdstring date-time required

The date and time when the Feedback was created in RFC 3339 format

modifiedstring date-time required

The date and time when the Feedback was last updated in RFC 3339 format

dueDatestring required

Define the due date of the feedback

shareKeystring

The share key of the feedback

pageUrlstring uri

The url of the page where the feedback was submitted

isPortalApprovedboolean required

Portal visibility. When true, the feedback is published to the project portal.

Actually appearing in the portal also requires Idea type and portal feature requests/roadmap enabled.

isPinnedboolean required

If true, the feedback has been pinned to the top of the feedback list in Userback

videoUrlstring uri

The URL of the video recording of the user submitting the feedback, if it exists

attachmentUrlstring uri

The URL of the attachment from the user submitting the feedback, if it exists

isSharedboolean required
voteCountnumber double required

The total amount of votes the feedback has received

This only applies to feedback that is a feature request

allowPublicCommentboolean required

If true, public comments are allowed to be posted on the feedback

priority'low' | 'neutral' | 'high' | 'urgent' required
categorystring

If defined, the category the feedback was assigned to

ratingstring required

Defines the rating given by the user submitting the feedback

userIdentificationstring required

The user identification

shareUrlstring uri required

The url of the feedback in Userback

Example response

{
  "id": 4455,
  "feedbackKey": "APP-123",
  "assigneeId": 4455,
  "projectId": 4455,
  "title": "This button doesn't work",
  "dueDate": "2024-02-30",
  "pageUrl": "https://example.com",
  "voteCount": 1234,
  "category": "Bug",
  "Workflow": {
    "id": 4455,
    "name": "In Progress",
    "sort": 1
  },
  "Assignee": {
    "id": 4455,
    "userId": 4455
  },
  "Screenshots": [
    {
      "id": 4455,
      "width": 1920,
      "height": 1080
    }
  ],
  "Session": {
    "colorDepth": 24,
    "dpi": 96,
    "resolutionY": 96,
    "resolutionX": 96,
    "windowHeight": 1080,
    "windowWidth": 1920,
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/99.0.1234.0 Safari/537.36",
    "uaData": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/99.0.1234.0 Safari/537.36"
  },
  "Location": {
    "postal": "90210",
    "subdivision": "California",
    "subdivisionCode": "CA",
    "city": "New York",
    "country": "United States",
    "countryCode": "US",
    "longitude": "-0.1278",
    "latitude": "51.5074"
  }
}

Changes

  • 2228601570e0Revision changes
    • breaking

      added the pattern ^(\d+|[A-Za-z0-9]+-[1-9][0-9]*)$ to the path request parameter id

    • warning

      for the path request parameter id, the maxLength was set to 32

    • warning

      added the new Task enum value to the response property for the response status

    • info

      added the new optional request property /

    • info

      for the path request parameter id, the type was generalized from integer to string, and format from int32 to no format

    • info

      added the new Task enum value to the request property ////

    • info

      added the optional property to the response with the status