klink-developers-logo

Ticket

Update

PATCH/api/v1/tickets/{id}

This endpoint allows you to update an existing ticket by its ID.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Path Params
  • idstringrequired

    The unique identifier of the ticket to update.

    Example:

Body Paramsapplication/json
  • titlestringoptional

    The title or subject of the ticket.

  • descriptionstringoptional

    Detailed description of the ticket issue or request.

  • statusstringoptional

    Status of the ticket (e.g., open, in progress, resolved).

  • typestringoptional

    The type of the ticket.

  • prioritystringoptional

    Priority level of the ticket (e.g., low, medium, high).

  • contactstringoptional

    The ID of the contact associated with this ticket.

  • assigneestringoptional

    The ID of the agent to assign to this ticket.

  • channelstringoptional

    The channel through which the ticket was created.

  • tagsarray[string]optional

    Array of tag IDs to associate with the ticket.

  • categoriesarray[string]optional

    Array of category IDs to associate with the ticket.

  • customFieldsobjectoptional

    Custom fields to associate with the ticket, as key-value pairs.

  • reasonToAssignstringoptional

    Reason for assigning the ticket to a specific agent.

Responses

200

OK

  • successbooleanrequired
  • dataobjectrequired
    Child attributes
    • idstringrequired
    • createdAtstringrequired
    • updatedAtstringrequired
    • deletedAtnullrequired
    • titlestringrequired
    • descriptionstringrequired
    • typestringrequired
    • channelstringrequired
    • prioritystringrequired
    • statusstringrequired
    • contactIdstringrequired
    • creatorIdstringrequired
    • assigneeIdstringrequired
    • reasonToAssignstringrequired
    • ticketNumberintegerrequired
    • assigneeobjectrequired
      Child attributes
      • idstringrequired
      • namestringrequired
      • emailstringrequired
    • contactobjectrequired
      Child attributes
      • idstringrequired
      • namestringrequired
    • tagsarray[object]required
      Child attributes
      • idstringoptional
      • namestringoptional
    • customFieldsarray[object]required
      Child attributes
      • idstringoptional
      • textValuestringoptional
      • attributeobjectoptional
        Child attributes
        • idstringrequired
        • systemNamestringrequired
        • displayNamestringrequired
        • typestringrequired