/tickets/{id}

from merge import Merge
from merge.resources.ticketing import PatchedTicketRequest
client = Merge(
    account_token="YOUR_ACCOUNT_TOKEN",
    api_key="YOUR_API_KEY",
)
client.ticketing.tickets.partial_update(
    id="id",
    model=PatchedTicketRequest(),
)

{
  "model": {
    "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
    "remote_id": "19202938",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "name": "Please add more integrations",
    "assignees": [
      "17a54124-287f-494d-965e-3c5b330c9a68"
    ],
    "assigned_teams": [
      "4857c306-c1f9-489e-a6b6-90902f736dfe"
    ],
    "creator": "string",
    "due_date": "2022-10-11T00:00:00Z",
    "status": "OPEN",
    "description": "Can you please add more integrations? It'll make syncing data much easier!",
    "collections": [
      "fb8c55b6-1cb8-4b4c-9fb6-17924231619d"
    ],
    "ticket_type": "incident",
    "account": "0958cbc6-6040-430a-848e-aafacbadf4ae",
    "contact": "65c345ba-6870-4974-87ba-dd31509c367a",
    "parent_ticket": "75b33d04-30d2-4f3e-be45-27838bc94342",
    "attachments": [
      "42747df1-95e7-46e2-93cc-66f1191edca5",
      "92f972d0-2526-434b-9409-4c3b468e08f0"
    ],
    "access_level": "PRIVATE",
    "permissions": [
      {}
    ],
    "tags": [
      "enterprise",
      "other-tag"
    ],
    "roles": [
      "21a54124-397f-494d-985e-3c5b330b8a68",
      "17a54124-287f-494d-965e-3c5b330c9a68"
    ],
    "ticket_url": "https://thirdpartysoftware.com/project/3/issue/1",
    "priority": "HIGH",
    "remote_created_at": "2021-11-10T00:00:00Z",
    "remote_updated_at": "2021-12-09T00:00:00Z",
    "completed_at": "2021-12-09T00:00:00Z",
    "remote_was_deleted": true,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/platform-endpoint"
      }
    ],
    "remote_fields": [
      {
        "remote_field_class": {
          "id": "string",
          "display_name": "string",
          "remote_key_name": "string",
          "description": "string",
          "is_custom": true,
          "is_common_model_field": true,
          "is_required": true,
          "field_type": "string",
          "field_format": "string",
          "field_choices": [
            "string"
          ],
          "item_schema": {
            "item_type": "string",
            "item_format": "string",
            "item_choices": [
              "string"
            ]
          }
        },
        "value": "string"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Updates a Ticket object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The Ticket object is used to represent a ticket, issue, task or case.

Usage Example

TODO

Response

modelobject

Description

The Ticket object is used to represent a ticket, issue, task or case.

Usage Example

TODO

warningslist of objects

errorslist of objects

logslist of objects or null

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

The individual Users who are assigned to this ticket. This does not include Users who just have view access to this ticket. To fetch all Users and Teams that can access the ticket, use the GET /tickets/{ticket_id}/viewers endpoint.

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

tagslist of stringsOptional

ticket_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Ticket.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

tagslist of stringsOptional

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

attachmentslist of stringsOptional

tagslist of stringsOptional

ticket_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Ticket.

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

completed_atdatetime or nullOptional

When the ticket was completed.

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

completed_atdatetime or nullOptional

When the ticket was completed.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

contactstring or nullOptionalformat: "uuid"

The contact associated with the ticket.

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

tagslist of stringsOptional

ticket_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Ticket.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

creatorstring or nullOptionalformat: "uuid"

The user who created this ticket.

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

attachmentslist of stringsOptional

tagslist of stringsOptional

ticket_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Ticket.

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

completed_atdatetime or nullOptional

When the ticket was completed.

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

tagslist of stringsOptional

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

access_levelenum or nullOptional

The description of who is able to access a given ticket, or where access is inherited from.

COMPANY - COMPANY
PUBLIC - PUBLIC
PRIVATE - PRIVATE
COLLECTION - COLLECTION

Allowed values:

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

Supported PATCH model parameters

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

assigned_teamslist of stringsOptional

The Teams that are assigned to this ticket. This does not include Teams who just have view access to this ticket. To fetch all Users and Teams that can access this ticket, use the GET /tickets/{ticket_id}/viewers endpoint.

creatorstring or nullOptionalformat: "uuid"

The user who created this ticket.

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

accountstring or nullOptionalformat: "uuid"

The account associated with the ticket.

contactstring or nullOptionalformat: "uuid"

The contact associated with the ticket.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

attachmentslist of stringsOptional

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

completed_atdatetime or nullOptional

When the ticket was completed.

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

tagslist of stringsOptional

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

ticket_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Ticket.

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

remote_datalist of objects or nullOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

tagslist of stringsOptional

ticket_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Ticket.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

tagslist of stringsOptional

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

attachmentslist of stringsOptional

tagslist of stringsOptional

ticket_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Ticket.

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

completed_atdatetime or nullOptional

When the ticket was completed.

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

completed_atdatetime or nullOptional

When the ticket was completed.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

contactstring or nullOptionalformat: "uuid"

The contact associated with the ticket.

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

tagslist of stringsOptional

ticket_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Ticket.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

creatorstring or nullOptionalformat: "uuid"

The user who created this ticket.

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

attachmentslist of stringsOptional

tagslist of stringsOptional

ticket_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Ticket.

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

completed_atdatetime or nullOptional

When the ticket was completed.

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

tagslist of stringsOptional

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

access_levelenum or nullOptional

The description of who is able to access a given ticket, or where access is inherited from.

COMPANY - COMPANY
PUBLIC - PUBLIC
PRIVATE - PRIVATE
COLLECTION - COLLECTION

Allowed values:

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_created_atdatetime or nullOptional

When the third party's ticket was created.

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

Supported PATCH model parameters

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

assigned_teamslist of stringsOptional

creatorstring or nullOptionalformat: "uuid"

The user who created this ticket.

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

accountstring or nullOptionalformat: "uuid"

The account associated with the ticket.

contactstring or nullOptionalformat: "uuid"

The contact associated with the ticket.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

attachmentslist of stringsOptional

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

completed_atdatetime or nullOptional

When the ticket was completed.

remote_fieldslist of objectsOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

tagslist of stringsOptional

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

descriptionstring or nullOptional

The ticket’s description. HTML version of description is mapped if supported by the third-party platform.

collectionslist of stringsOptional

The Collections that this Ticket is included in.

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

parent_ticketstring or nullOptionalformat: "uuid"

The ticket's parent ticket.

ticket_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party url of the Ticket.

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

remote_datalist of objects or nullOptionalRead-only

Supported PATCH model parameters

remote_idstring or nullOptional

The third-party API ID of the matching object.

namestring or nullOptional

The ticket's name.

assigneeslist of stringsOptional

due_datedatetime or nullOptional

The ticket's due date.

statusenum or nullOptional

The current status of the ticket.

OPEN - OPEN
CLOSED - CLOSED
IN_PROGRESS - IN_PROGRESS
ON_HOLD - ON_HOLD

Allowed values:

ticket_typestring or nullOptional

The sub category of the ticket within the 3rd party system. Examples include incident, task, subtask or to-do.

tagslist of stringsOptional

priorityenum or nullOptional

The priority or urgency of the Ticket.

URGENT - URGENT
HIGH - HIGH
NORMAL - NORMAL
LOW - LOW

Allowed values:

remote_updated_atdatetime or nullOptional

When the third party's ticket was updated.

/tickets/{id}

Authentication

Path parameters

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Field support by integration