Sign in
latestOpenAPI 3.0.32026-08-20147323331.7 KB

a7231589e927

issues

Update an existing issue

Updates an existing issue. Only provided fields are modified.

Rate limit: 20 requests per minute

patch/issues/{id}

Path parameters

idstring required

The ID of the issue to update.

Request body

account_idstring

The ID of the account that this issue belongs to.

assignee_idstring

The ID of the user who should be assigned to this issue. If empty string is passed in, the issue assignee will be removed.

customer_portal_visibleboolean

Whether the issue should be visible in the customer portal.

requester_idstring

The ID of the requester that this issue is on behalf of.

requestor_idstring

Deprecated: Use requester_id instead.

statestring

The state this issue should be moved to. Standard values are new, waiting_on_you, waiting_on_customer, on_hold, and closed; custom status slugs are also supported.

tagsstring[]

An array of strings to use as tags on this issue. If provided, the issue tags will be updated to be exactly the given tags.

team_idstring

The ID of the team this issue should be assigned to. If empty string is passed in, any assigned team will be removed.

titlestring

The title of the issue.

type'conversation' | 'ticket'

The type of the issue. Set to "ticket" to upgrade a conversation to a support ticket. Cannot be downgraded from "ticket" to "conversation".

Example request

{
  "state": "new"
}

Response

request_idstring

The request ID for tracking.

Example response

{
  "data": {
    "business_hours_time_in_status_seconds": {
      "new": 120,
      "waiting_on_customer": 1800
    },
    "custom_fields": {
      "priority": {
        "value": "high"
      }
    },
    "state": "new",
    "time_in_status_seconds": {
      "new": 120,
      "waiting_on_customer": 3600
    }
  }
}