CAcapacity
Tickets

Update a ticket

Update a ticket.

patch/v1/tickets/{ticket_id}

Request

  • Base URL
    https://api.capacity.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-capacity-id
    • or HTTP bearer

Path parameters

ticket_idstring required

UUID of the ticket

Request body

assigned_userstring

Name of assigned user

descriptionstring

Ticket description

due_datestring

Ticket due date

priority_idinteger

Ticket priority

project_uuidstring

Uuid of the ticket's project

reporter_emailstring

Email of reporter

status_idinteger

Ticket status

tagsstring[]

List of ticket tags

ticket_type_idinteger

Ticket type

titlestring

Ticket title

should_check_for_required_custom_fields_on_closeboolean

If true, the ticket will be checked for required custom fields when attempting to close

custom_fieldsobject

Custom field values to update on the ticket. Supports both simple fields and dependent (parent-child) fields.

Simple fields: Direct key-value pairs where keys are field names and values can be strings, numbers, arrays, or null.

Dependent fields: Use nested structure with "value" for parent and "dependent_fields" for children.

Null values: Use null to clear/deselect fields. Empty strings in arrays are treated as cleared.

Dependent Field Behavior: Consider a "Color" parent field with options [Blue, Red, Green] and "Shade" child field with:

  • Blue → [Navy, Turquoise, Sky Blue]
  • Red → [Crimson, Scarlet, Cherry]
  • Green → [Emerald, Lime, Forest]

Important: When changing parent values, you cannot change both parent and child in the same request.

Example - To change from "Blue → Navy" to "Red → Crimson":

  1. First request: {"color_field": {"value": "Red"}} (child becomes null)
  2. Second request: {"color_field": {"value": "Red", "dependent_fields": {"shade_field": ["Crimson"]}}}

This ensures dependent validation works correctly.

Example request

{
  "custom_fields": {
    "text_field": "some text",
    "numeric_field": 42,
    "multi_select": [
      "option1",
      "option2"
    ],
    "cleared_field": null,
    "parent_field": {
      "value": "Blue",
      "dependent_fields": {
        "child_field": [
          "Navy",
          "Turquoise"
        ],
        "another_child": null
      }
    }
  }
}

Response

The updated ticket

bodyobject

Json body data in the request

parametersobject

Query parameters in the request

Changes

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