> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# zendesk-tickets
> Zendesk Tickets — manage tickets, comments, search, and tags
**Server path:** `/zendesk-tickets` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`zendesk_tickets_add_ticket_tags`](#zendesk_tickets_add_ticket_tags) | Add Tags |
| [`zendesk_tickets_bulk_delete_tickets`](#zendesk_tickets_bulk_delete_tickets) | Bulk Delete Tickets |
| [`zendesk_tickets_count_ticket_comments`](#zendesk_tickets_count_ticket_comments) | Count Ticket Comments |
| [`zendesk_tickets_count_tickets`](#zendesk_tickets_count_tickets) | Count Tickets |
| [`zendesk_tickets_create_many`](#zendesk_tickets_create_many) | Create Many Tickets |
| [`zendesk_tickets_create_ticket`](#zendesk_tickets_create_ticket) | Create Ticket |
| [`zendesk_tickets_delete_ticket`](#zendesk_tickets_delete_ticket) | Delete Ticket |
| [`zendesk_tickets_get_ticket`](#zendesk_tickets_get_ticket) | Show Ticket |
| [`zendesk_tickets_list_deleted_tickets`](#zendesk_tickets_list_deleted_tickets) | List Deleted Tickets |
| [`zendesk_tickets_list_organization_tickets`](#zendesk_tickets_list_organization_tickets) | List Organization Tickets |
| [`zendesk_tickets_list_recent_tickets`](#zendesk_tickets_list_recent_tickets) | List Recent Tickets |
| [`zendesk_tickets_list_satisfaction_ratings`](#zendesk_tickets_list_satisfaction_ratings) | List Satisfaction Ratings |
| [`zendesk_tickets_list_ticket_collaborators`](#zendesk_tickets_list_ticket_collaborators) | List Collaborators for a Ticket |
| [`zendesk_tickets_list_ticket_comments`](#zendesk_tickets_list_ticket_comments) | List Comments |
| [`zendesk_tickets_list_ticket_followers`](#zendesk_tickets_list_ticket_followers) | List Followers for a Ticket |
| [`zendesk_tickets_list_ticket_problems`](#zendesk_tickets_list_ticket_problems) | List Ticket Problems |
| [`zendesk_tickets_list_ticket_tags`](#zendesk_tickets_list_ticket_tags) | List Resource Tags |
| [`zendesk_tickets_list_tickets`](#zendesk_tickets_list_tickets) | List Tickets |
| [`zendesk_tickets_list_tickets_with_comments`](#zendesk_tickets_list_tickets_with_comments) | Fetch multiple tickets and their comments in a single call (max 500 ticket IDs). Handles large volumes by chunking ticket fetches (100 per show\_many call) and fetching comments serially to respect Zendesk rate limits. Failed tickets are recorded in metadata but do not abort the batch. |
| [`zendesk_tickets_list_user_assigned_tickets`](#zendesk_tickets_list_user_assigned_tickets) | List User Assigned Tickets |
| [`zendesk_tickets_list_user_requested_tickets`](#zendesk_tickets_list_user_requested_tickets) | List User Requested Tickets |
| [`zendesk_tickets_make_ticket_comment_private`](#zendesk_tickets_make_ticket_comment_private) | Make Comment Private |
| [`zendesk_tickets_merge_tickets_into_target_ticket`](#zendesk_tickets_merge_tickets_into_target_ticket) | Merge Tickets into Target Ticket |
| [`zendesk_tickets_remove_ticket_tags`](#zendesk_tickets_remove_ticket_tags) | Remove Tags |
| [`zendesk_tickets_restore_deleted_ticket`](#zendesk_tickets_restore_deleted_ticket) | Restore a Previously Deleted Ticket |
| [`zendesk_tickets_search`](#zendesk_tickets_search) | List Search Results |
| [`zendesk_tickets_search_export`](#zendesk_tickets_search_export) | Export Search Results |
| [`zendesk_tickets_set_ticket_tags`](#zendesk_tickets_set_ticket_tags) | Set Tags |
| [`zendesk_tickets_show_attachment`](#zendesk_tickets_show_attachment) | Show Attachment |
| [`zendesk_tickets_show_many`](#zendesk_tickets_show_many) | Show Multiple Tickets |
| [`zendesk_tickets_show_satisfaction_rating`](#zendesk_tickets_show_satisfaction_rating) | Show Satisfaction Rating |
| [`zendesk_tickets_show_ticket_metrics_by_ticket`](#zendesk_tickets_show_ticket_metrics_by_ticket) | Show Ticket Metrics By Ticket |
| [`zendesk_tickets_ticket_related_information`](#zendesk_tickets_ticket_related_information) | Ticket Related Information |
| [`zendesk_tickets_update_many`](#zendesk_tickets_update_many) | Update Many Tickets |
| [`zendesk_tickets_update_ticket`](#zendesk_tickets_update_ticket) | Update Ticket |
| [`zendesk-tickets_bulk_recover_suspended_tickets`](#zendesk-tickets_bulk_recover_suspended_tickets) | Bulk Recover Suspended Tickets |
| [`zendesk-tickets_create_saved_search`](#zendesk-tickets_create_saved_search) | Create Saved Search |
| [`zendesk-tickets_delete_saved_search`](#zendesk-tickets_delete_saved_search) | Delete Saved Search |
| [`zendesk-tickets_list_saved_searches`](#zendesk-tickets_list_saved_searches) | List Saved Searches |
| [`zendesk-tickets_update_saved_search`](#zendesk-tickets_update_saved_search) | Update Saved Search |
***
## zendesk\_tickets\_add\_ticket\_tags
Add Tags
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | -------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_bulk\_delete\_tickets
Bulk Delete Tickets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------- |
| `ids` | string | Yes | — | Comma-separated list of ticket ids |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "string",
"description": "Comma-separated list of ticket ids"
}
},
"required": [
"PCID",
"ids"
]
}
```
***
## zendesk\_tickets\_count\_ticket\_comments
Count Ticket Comments
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | -------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_count\_tickets
Count Tickets
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## zendesk\_tickets\_create\_many
Create Many Tickets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ----------------- |
| `tickets` | object\[] | No | — | The tickets value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tickets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"additional_collaborators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"description": "Write only. An array of numeric IDs, emails, or objects containing name and email properties. See [Setting Collaborators](/api-reference/ticketing/tickets/tickets/#setting-collaborators). An email notification is sent to them when the ticket is updated"
},
"allow_attachments": {
"type": "boolean",
"description": "Permission for agents to add add attachments to a comment. Defaults to true"
},
"allow_channelback": {
"type": "boolean",
"description": "Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket"
},
"assignee_email": {
"type": "string",
"format": "email",
"description": "Write only. The email address of the agent to assign the ticket to"
},
"assignee_id": {
"type": "integer",
"format": "int64",
"description": "The agent currently assigned to the ticket"
},
"attribute_value_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Write only. An array of the IDs of attribute values to be associated with the ticket"
},
"brand_id": {
"type": "integer",
"format": "int64",
"description": "The id of the brand this ticket is associated with. See [Setting up multiple brands](https://support.zendesk.com/hc/en-us/articles/4408829476378)"
},
"collaborator_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ids of users currently CC'ed on the ticket"
},
"collaborators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"description": "Write only. Users to add as cc's when creating a ticket. See [Setting Collaborators](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#setting-collaborators)"
},
"comment": {
"type": "object",
"description": "The comment value"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When this record was created"
},
"custom_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the custom field"
},
"value": {
"description": "The value to assign to the custom field. Type depends on the field configuration: - Text/textarea: string - Checkbox: boolean or \"true\"/\"false\" string - Dropdown/tagger: string or array of strings (multi-select) - Number/decimal: number or string representation - Date: string (ISO 8601 format) "
}
}
},
"description": "Custom field values to set on the ticket. Each entry specifies a field ID and its value. See [Setting custom field values](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#setting-custom-field-values)"
},
"custom_status_id": {
"type": "integer",
"format": "int64",
"description": "The custom ticket status id of the ticket. See [custom ticket statuses](#custom-ticket-statuses)"
},
"description": {
"type": "string",
"description": "The first comment on the ticket. When [creating a ticket](#create-ticket), use `comment` to set the description. See [Description and first comment](#description-and-first-comment). On create, can be set directly as an alternative to `comment`. Silently ignored on update."
},
"due_at": {
"type": "string",
"format": "date-time",
"description": "If this is a ticket of type \"task\" it has a due date. Due date format uses [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format"
},
"email_cc_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ids of agents or end users currently CC'ed on the ticket. See [CCs and followers resources](https://support.zendesk.com/hc/en-us/articles/4408822451482) in the Support Help Center"
},
"email_ccs": {
"type": "array",
"items": {
"type": "object"
},
"description": "Write only. An array of objects that represent agent or end users email CCs to add or delete from the ticket. See [Setting email CCs](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#setting-email-ccs). Ignored when [CCs and followers](https://support.zendesk.com/hc/en-us/articles/4408822451482) is not enabled"
},
"encoded_id": {
"type": "string",
"description": "An encoded string representing the ticket's unique identifier"
},
"external_id": {
"type": "string",
"description": "An id you can use to link Zendesk Support tickets to local records"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the custom field"
},
"value": {
"description": "The value to assign to the custom field. Type depends on the field configuration: - Text/textarea: string - Checkbox: boolean or \"true\"/\"false\" string - Dropdown/tagger: string or array of strings (multi-select) - Number/decimal: number or string representation - Date: string (ISO 8601 format) "
}
}
},
"description": "Alias for custom_fields. Custom field values to set on the ticket. Each entry specifies a field ID and its value."
},
"follower_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ids of agents currently following the ticket. Ignored when [CCs and followers](https://support.zendesk.com/hc/en-us/articles/4408822451482) is not enabled"
},
"followers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string"
},
"user_email": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"user_name": {
"type": "string"
}
}
},
"description": "Write only. An array of objects that represents agent followers to add or delete from the ticket. See [Setting followers](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#setting-followers). Ignored when [CCs and followers](https://support.zendesk.com/hc/en-us/articles/4408822451482) is not enabled"
},
"followup_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The ids of the followups created from this ticket. Ids are only visible once the ticket is closed"
},
"forum_topic_id": {
"type": "integer",
"format": "int64",
"description": "The topic in the Zendesk Web portal this ticket originated from, if any. The Web portal is deprecated"
},
"from_messaging_channel": {
"type": "boolean",
"description": "If true, the ticket's [via type](/documentation/ticketing/reference-guides/via-object-reference/) is a messaging channel."
},
"generated_timestamp": {
"type": "integer",
"description": "A Unix timestamp that represents the most accurate reading of when this record was last updated. It is updated for all ticket updates, including system updates"
},
"group_id": {
"type": "integer",
"format": "int64",
"description": "The group this ticket is assigned to"
},
"has_incidents": {
"type": "boolean",
"description": "Is true if a ticket is a problem type and has one or more incidents linked to it. Otherwise, the value is false."
},
"id": {
"type": "integer",
"format": "int64",
"description": "Automatically assigned when the ticket is created"
},
"is_public": {
"type": "boolean",
"description": "Is true if any comments are public, false otherwise"
},
"macro_id": {
"type": "integer",
"format": "int64",
"description": "Write only. A single macro ID to be recorded in the ticket audit"
},
"macro_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Write only. List of macro IDs to be recorded in the ticket audit"
},
"metadata": {
"type": "object",
"description": "Write only. Metadata for the audit. In the `audit` object, the data is specified in the `custom` property of the `metadata` object. See [Setting Metadata](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#setting-metadata)"
},
"organization_id": {
"type": "integer",
"format": "int64",
"description": "The organization of the requester. You can only specify the ID of an organization associated with the requester. See [Organization Memberships](/api-reference/ticketing/organizations/organization_memberships/)"
},
"origin_zrn": {
"type": "string",
"description": "Write only. The Zendesk Resource Name (ZRN) of the origin for this ticket"
},
"priority": {
"type": "string",
"enum": [
"urgent",
"high",
"normal",
"low"
],
"description": "The urgency with which the ticket should be addressed"
},
"problem_id": {
"type": "integer",
"format": "int64",
"description": "For tickets of type \"incident\", the ID of the problem the incident is linked to"
},
"raw_subject": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"subject\" value, if not. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/). When set on create or update, overrides the `subject` field."
},
"recipient": {
"type": "string",
"description": "The original recipient e-mail address of the ticket. Notification emails for the ticket are sent from this address"
},
"requester": {
"description": "Write only. Alternative to requester_id for specifying the ticket requester. Can be provided as: - Email string: \"user@example.com\" - User ID integer: 12345 - User object: {name: \"John Doe\", email: \"john@example.com\"} If both requester and requester_id are provided, requester_id takes precedence. When creating a ticket, if the user doesn't exist, they may be created automatically depending on account settings."
},
"requester_id": {
"type": "integer",
"format": "int64",
"description": "The user who requested this ticket"
},
"safe_update": {
"type": "boolean",
"description": "Write only. Optional boolean. When true and an `updated_stamp` date is included, protects against ticket update collisions and returns a message to let you know if one occurs. See [Protecting against ticket update collisions](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#protecting-against-ticket-update-collisions). A value of false has the same effect as true. Omit the property to force the updates to not be safe"
},
"satisfaction_probability": {
"type": "number",
"description": "The predicted satisfaction probability score"
},
"satisfaction_rating": {
"type": "object",
"description": "The satisfaction rating of the ticket, if it exists, or the state of satisfaction, \"offered\" or \"unoffered\". The value is null for plan types that don't support CSAT"
},
"sharing_agreement_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "An array of the numeric IDs of sharing agreements. Note that this replaces any existing agreements"
},
"sharing_agreements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"custom_fields": {
"type": "array"
},
"id": {
"type": "integer",
"description": "The ID of the sharing agreement"
}
}
},
"description": "Write only. Sharing agreement configuration for the ticket. Accepts a single object or an array of objects."
},
"status": {
"type": "string",
"enum": [
"new",
"open",
"pending",
"hold",
"solved",
"closed"
],
"description": "The state of the ticket. If your account has activated custom ticket statuses, this is the ticket's status category. See [custom ticket statuses](#custom-ticket-statuses)"
},
"subject": {
"type": "string",
"description": "The value of the subject field for this ticket. See [Subject](/api-reference/ticketing/tickets/tickets/#subject)"
},
"submitter_id": {
"type": "integer",
"format": "int64",
"description": "The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket. If not specified, defaults to the authenticated user."
},
"support_type": {
"type": "string",
"enum": [
"agent",
"ai_agent"
],
"description": "The type of support that handled the ticket"
},
"suspended_ticket_id": {
"type": "integer",
"format": "int64",
"description": "Write only. The ID of the suspended ticket being recovered"
},
"suspension_type_id": {
"type": "integer",
"format": "int64",
"description": "Write only. The suspension type ID when recovering a suspended ticket"
},
"system_metadata": {
"type": "object",
"description": "Write only. System metadata for the ticket, typically set by internal clients"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags applied to this ticket. Unless otherwise specified, the [set tag](/api-reference/ticketing/ticket-management/tags/#set-tags) behavior is used, which overwrites and replaces existing tags"
},
"tde_workspace": {
"type": "object",
"description": "Write only. TDE workspace information for the ticket"
},
"ticket_form_id": {
"type": "integer",
"format": "int64",
"description": "Enterprise only. The id of the ticket form to render for the ticket"
},
"tpe_voice_comment": {
"type": "object",
"description": "Write only. A TPE voice comment for Talk Partner Edition tickets"
},
"type": {
"type": "string",
"enum": [
"problem",
"incident",
"question",
"task"
],
"description": "The type of this ticket"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When this record last got updated. It is updated only if the update generates a [ticket event](#incremental-ticket-event-export)"
},
"updated_stamp": {
"type": "string",
"format": "date-time",
"description": "Write only. Datetime of last update received from API. See the `safe_update` property"
},
"url": {
"type": "string",
"description": "The API url of this ticket"
},
"via": {
"type": "object",
"description": "An object explaining how the ticket was created. See the [Via object reference](/documentation/ticketing/reference-guides/via-object-reference)"
},
"via_followup_source_id": {
"type": "integer",
"format": "int64",
"description": "Write only. The id of a closed ticket when creating a follow-up ticket. See [Creating a follow-up ticket](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#creating-a-follow-up-ticket)"
},
"via_id": {
"type": "integer",
"format": "int64",
"description": "Write only. For more information, see the [Via object reference](/documentation/ticketing/reference-guides/via-object-reference/)"
},
"voice_comment": {
"type": "object",
"description": "Write only. A voice comment for Talk tickets. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets/)"
}
}
},
"description": "The tickets value"
}
},
"required": [
"PCID"
]
}
```
***
## zendesk\_tickets\_create\_ticket
Create Ticket
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------ |
| `include` | string | No | — | Sideloads to include in the response. Accepts a comma-separated list of values. See Sideloading. |
| `system_metadata` | object | No | — | System metadata for the request, typically set by internal clients |
| `ticket` | object | No | — | The ticket value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"include": {
"type": "string",
"description": "Sideloads to include in the response. Accepts a comma-separated list of values. See [Sideloading](/api-reference/ticketing/tickets/tickets/#sideloading)."
},
"system_metadata": {
"type": "object",
"description": "System metadata for the request, typically set by internal clients"
},
"ticket": {
"type": "object",
"description": "The ticket value",
"properties": {
"additional_collaborators": {
"type": "array",
"items": {
"type": "object"
},
"description": "Write only. An array of numeric IDs, emails, or objects containing name and email properties. See [Setting Collaborators](/api-reference/ticketing/tickets/tickets/#setting-collaborators). An email notification is sent to them when the ticket is updated"
},
"allow_attachments": {
"type": "boolean",
"description": "Permission for agents to add add attachments to a comment. Defaults to true"
},
"allow_channelback": {
"type": "boolean",
"description": "Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket"
},
"assignee_email": {
"type": "string",
"description": "Write only. The email address of the agent to assign the ticket to"
},
"assignee_id": {
"type": "integer",
"description": "The agent currently assigned to the ticket"
},
"attribute_value_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Write only. An array of the IDs of attribute values to be associated with the ticket"
},
"brand_id": {
"type": "integer",
"description": "The id of the brand this ticket is associated with. See [Setting up multiple brands](https://support.zendesk.com/hc/en-us/articles/4408829476378)"
},
"collaborator_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The ids of users currently CC'ed on the ticket"
},
"collaborators": {
"type": "array",
"items": {
"type": "object"
},
"description": "Write only. Users to add as cc's when creating a ticket. See [Setting Collaborators](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#setting-collaborators)"
},
"comment": {
"type": "object",
"description": "The comment value"
},
"created_at": {
"type": "string",
"description": "When this record was created"
},
"custom_fields": {
"type": "array",
"items": {
"type": "object"
},
"description": "Custom field values to set on the ticket. Each entry specifies a field ID and its value. See [Setting custom field values](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#setting-custom-field-values)"
},
"custom_status_id": {
"type": "integer",
"description": "The custom ticket status id of the ticket. See [custom ticket statuses](#custom-ticket-statuses)"
},
"description": {
"type": "string",
"description": "The first comment on the ticket. When [creating a ticket](#create-ticket), use `comment` to set the description. See [Description and first comment](#description-and-first-comment). On create, can be set directly as an alternative to `comment`. Silently ignored on update."
},
"due_at": {
"type": "string",
"description": "If this is a ticket of type \"task\" it has a due date. Due date format uses [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format"
},
"email_cc_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The ids of agents or end users currently CC'ed on the ticket. See [CCs and followers resources](https://support.zendesk.com/hc/en-us/articles/4408822451482) in the Support Help Center"
},
"email_ccs": {
"type": "array",
"items": {
"type": "object"
},
"description": "Write only. An array of objects that represent agent or end users email CCs to add or delete from the ticket. See [Setting email CCs](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#setting-email-ccs). Ignored when [CCs and followers](https://support.zendesk.com/hc/en-us/articles/4408822451482) is not enabled"
},
"encoded_id": {
"type": "string",
"description": "An encoded string representing the ticket's unique identifier"
},
"external_id": {
"type": "string",
"description": "An id you can use to link Zendesk Support tickets to local records"
},
"fields": {
"type": "array",
"items": {
"type": "object"
},
"description": "Alias for custom_fields. Custom field values to set on the ticket. Each entry specifies a field ID and its value."
},
"follower_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The ids of agents currently following the ticket. Ignored when [CCs and followers](https://support.zendesk.com/hc/en-us/articles/4408822451482) is not enabled"
},
"followers": {
"type": "array",
"items": {
"type": "object"
},
"description": "Write only. An array of objects that represents agent followers to add or delete from the ticket. See [Setting followers](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#setting-followers). Ignored when [CCs and followers](https://support.zendesk.com/hc/en-us/articles/4408822451482) is not enabled"
},
"followup_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The ids of the followups created from this ticket. Ids are only visible once the ticket is closed"
},
"forum_topic_id": {
"type": "integer",
"description": "The topic in the Zendesk Web portal this ticket originated from, if any. The Web portal is deprecated"
},
"from_messaging_channel": {
"type": "boolean",
"description": "If true, the ticket's [via type](/documentation/ticketing/reference-guides/via-object-reference/) is a messaging channel."
},
"generated_timestamp": {
"type": "integer",
"description": "A Unix timestamp that represents the most accurate reading of when this record was last updated. It is updated for all ticket updates, including system updates"
},
"group_id": {
"type": "integer",
"description": "The group this ticket is assigned to"
},
"has_incidents": {
"type": "boolean",
"description": "Is true if a ticket is a problem type and has one or more incidents linked to it. Otherwise, the value is false."
},
"id": {
"type": "integer",
"description": "Automatically assigned when the ticket is created"
},
"is_public": {
"type": "boolean",
"description": "Is true if any comments are public, false otherwise"
},
"macro_id": {
"type": "integer",
"description": "Write only. A single macro ID to be recorded in the ticket audit"
},
"macro_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Write only. List of macro IDs to be recorded in the ticket audit"
},
"metadata": {
"type": "object",
"description": "Write only. Metadata for the audit. In the `audit` object, the data is specified in the `custom` property of the `metadata` object. See [Setting Metadata](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#setting-metadata)"
},
"organization_id": {
"type": "integer",
"description": "The organization of the requester. You can only specify the ID of an organization associated with the requester. See [Organization Memberships](/api-reference/ticketing/organizations/organization_memberships/)"
},
"origin_zrn": {
"type": "string",
"description": "Write only. The Zendesk Resource Name (ZRN) of the origin for this ticket"
},
"priority": {
"type": "string",
"description": "The urgency with which the ticket should be addressed",
"enum": [
"urgent",
"high",
"normal",
"low"
]
},
"problem_id": {
"type": "integer",
"description": "For tickets of type \"incident\", the ID of the problem the incident is linked to"
},
"raw_subject": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"subject\" value, if not. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/). When set on create or update, overrides the `subject` field."
},
"recipient": {
"type": "string",
"description": "The original recipient e-mail address of the ticket. Notification emails for the ticket are sent from this address"
},
"requester": {
"description": "Write only. Alternative to requester_id for specifying the ticket requester. Can be provided as: - Email string: \"user@example.com\" - User ID integer: 12345 - User object: {name: \"John Doe\", email: \"john@example.com\"} If both requester and requester_id are provided, requester_id takes precedence. When creating a ticket, if the user doesn't exist, they may be created automatically depending on account settings."
},
"requester_id": {
"type": "integer",
"description": "The user who requested this ticket"
},
"safe_update": {
"type": "boolean",
"description": "Write only. Optional boolean. When true and an `updated_stamp` date is included, protects against ticket update collisions and returns a message to let you know if one occurs. See [Protecting against ticket update collisions](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#protecting-against-ticket-update-collisions). A value of false has the same effect as true. Omit the property to force the updates to not be safe"
},
"satisfaction_probability": {
"type": "number",
"description": "The predicted satisfaction probability score"
},
"satisfaction_rating": {
"type": "object",
"description": "The satisfaction rating of the ticket, if it exists, or the state of satisfaction, \"offered\" or \"unoffered\". The value is null for plan types that don't support CSAT"
},
"sharing_agreement_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "An array of the numeric IDs of sharing agreements. Note that this replaces any existing agreements"
},
"sharing_agreements": {
"type": "array",
"items": {
"type": "object"
},
"description": "Write only. Sharing agreement configuration for the ticket. Accepts a single object or an array of objects."
},
"status": {
"type": "string",
"description": "The state of the ticket. If your account has activated custom ticket statuses, this is the ticket's status category. See [custom ticket statuses](#custom-ticket-statuses)",
"enum": [
"new",
"open",
"pending",
"hold",
"solved",
"closed"
]
},
"subject": {
"type": "string",
"description": "The value of the subject field for this ticket. See [Subject](/api-reference/ticketing/tickets/tickets/#subject)"
},
"submitter_id": {
"type": "integer",
"description": "The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket. If not specified, defaults to the authenticated user."
},
"support_type": {
"type": "string",
"description": "The type of support that handled the ticket",
"enum": [
"agent",
"ai_agent"
]
},
"suspended_ticket_id": {
"type": "integer",
"description": "Write only. The ID of the suspended ticket being recovered"
},
"suspension_type_id": {
"type": "integer",
"description": "Write only. The suspension type ID when recovering a suspended ticket"
},
"system_metadata": {
"type": "object",
"description": "Write only. System metadata for the ticket, typically set by internal clients"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags applied to this ticket. Unless otherwise specified, the [set tag](/api-reference/ticketing/ticket-management/tags/#set-tags) behavior is used, which overwrites and replaces existing tags"
},
"tde_workspace": {
"type": "object",
"description": "Write only. TDE workspace information for the ticket"
},
"ticket_form_id": {
"type": "integer",
"description": "Enterprise only. The id of the ticket form to render for the ticket"
},
"tpe_voice_comment": {
"type": "object",
"description": "Write only. A TPE voice comment for Talk Partner Edition tickets"
},
"type": {
"type": "string",
"description": "The type of this ticket",
"enum": [
"problem",
"incident",
"question",
"task"
]
},
"updated_at": {
"type": "string",
"description": "When this record last got updated. It is updated only if the update generates a [ticket event](#incremental-ticket-event-export)"
},
"updated_stamp": {
"type": "string",
"description": "Write only. Datetime of last update received from API. See the `safe_update` property"
},
"url": {
"type": "string",
"description": "The API url of this ticket"
},
"via": {
"type": "object",
"description": "An object explaining how the ticket was created. See the [Via object reference](/documentation/ticketing/reference-guides/via-object-reference)"
},
"via_followup_source_id": {
"type": "integer",
"description": "Write only. The id of a closed ticket when creating a follow-up ticket. See [Creating a follow-up ticket](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#creating-a-follow-up-ticket)"
},
"via_id": {
"type": "integer",
"description": "Write only. For more information, see the [Via object reference](/documentation/ticketing/reference-guides/via-object-reference/)"
},
"voice_comment": {
"type": "object",
"description": "Write only. A voice comment for Talk tickets. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets/)"
}
}
}
},
"required": [
"PCID"
]
}
```
***
## zendesk\_tickets\_delete\_ticket
Delete Ticket
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | -------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_get\_ticket
Show Ticket
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------ |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
| `include` | string | No | — | Sideloads to include in the response. Accepts a comma-separated list of values. See Sideloading. |
| `reduced_payload_size` | boolean | No | — | When true, returns a reduced ticket payload (omits null custom fields). |
| `remove_duplicate_fields` | boolean | No | — | When true, removes duplicate custom field entries from the response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
},
"include": {
"type": "string",
"description": "Sideloads to include in the response. Accepts a comma-separated list of values. See [Sideloading](/api-reference/ticketing/tickets/tickets/#sideloading)."
},
"reduced_payload_size": {
"type": "boolean",
"description": "When true, returns a reduced ticket payload (omits null custom fields)."
},
"remove_duplicate_fields": {
"type": "boolean",
"description": "When true, removes duplicate custom field entries from the response."
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_list\_deleted\_tickets
List Deleted Tickets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sort_by` | string | No | — | Sort by |
| `sort_order` | string | No | — | Sort order. Defaults to "asc" |
| `support_type_scope` | string | No | — | Lists tickets by support type. Possible values are "all", "agent", or "ai\_agent". Defaults to "agent" |
| `page` | object | No | — | Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both. |
| `per_page` | integer | No | — | Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"sort_by": {
"type": "string",
"description": "Sort by",
"enum": [
"id",
"subject",
"deleted_at",
"created_at",
"updated_at",
"status",
"requester",
"requester.name",
"group",
"assignee",
"assignee.name"
]
},
"sort_order": {
"type": "string",
"description": "Sort order. Defaults to \"asc\"",
"enum": [
"asc",
"desc"
]
},
"support_type_scope": {
"type": "string",
"description": "Lists tickets by support type. Possible values are \"all\", \"agent\", or \"ai_agent\". Defaults to \"agent\""
},
"page": {
"description": "Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both."
},
"per_page": {
"type": "integer",
"description": "Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
}
},
"required": [
"PCID"
]
}
```
***
## zendesk\_tickets\_list\_organization\_tickets
List Organization Tickets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | ------------------------- |
| `organization_id` | integer | Yes | — | The ID of an organization |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "integer",
"description": "The ID of an organization"
}
},
"required": [
"PCID",
"organization_id"
]
}
```
***
## zendesk\_tickets\_list\_recent\_tickets
List Recent Tickets
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## zendesk\_tickets\_list\_satisfaction\_ratings
List Satisfaction Ratings
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | object | No | — | Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both. |
| `per_page` | integer | No | — | Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
| `sort` | string | No | — | Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at` |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"description": "Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both."
},
"per_page": {
"type": "integer",
"description": "Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
},
"sort": {
"type": "string",
"description": "Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`"
}
},
"required": [
"PCID"
]
}
```
***
## zendesk\_tickets\_list\_ticket\_collaborators
List Collaborators for a Ticket
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | -------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_list\_ticket\_comments
List Comments
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
| `include_inline_images` | boolean | No | — | Default is false. When true, inline images are also listed as attachments in the response |
| `include` | string | No | — | Accepts "users". Use this parameter to list email CCs by side-loading users. Example: `?include=users`. **Note**: If the comment source is email, a deleted user will be represented as the CCd email address. If the comment source is anything else, a deleted user will be represented as the user name. |
| `per_page` | integer | No | — | Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
| `sort_order` | string | No | — | Sort order. Defaults to "asc" |
| `page` | object | No | — | Cursor-based pagination parameters (JSON:API style). Supports nested parameters: - `page[size]` - Number of records per page (default varies by endpoint, typically 100) - `page[after]` - Cursor token to fetch records after this position - `page[before]` - Cursor token to fetch records before this position Example: `?page[size]=50&page[after]=eyJvIjoiaWQiLCJ2IjoiYVFFPSJ9` |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
},
"include_inline_images": {
"type": "boolean",
"description": "Default is false. When true, inline images are also listed as attachments in the response"
},
"include": {
"type": "string",
"description": "Accepts \"users\". Use this parameter to list email CCs by side-loading users. Example: `?include=users`. **Note**: If the comment source is email, a deleted user will be represented as the CCd email address. If the comment source is anything else, a deleted user will be represented as the user name."
},
"per_page": {
"type": "integer",
"description": "Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
},
"sort_order": {
"type": "string",
"description": "Sort order. Defaults to \"asc\"",
"enum": [
"asc",
"desc"
]
},
"page": {
"type": "object",
"description": "Cursor-based pagination parameters (JSON:API style). Supports nested parameters: - `page[size]` - Number of records per page (default varies by endpoint, typically 100) - `page[after]` - Cursor token to fetch records after this position - `page[before]` - Cursor token to fetch records before this position Example: `?page[size]=50&page[after]=eyJvIjoiaWQiLCJ2IjoiYVFFPSJ9`",
"properties": {
"after": {
"type": "string",
"description": "Cursor token for fetching next page"
},
"before": {
"type": "string",
"description": "Cursor token for fetching previous page"
},
"size": {
"type": "integer",
"description": "Number of records per page"
}
}
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_list\_ticket\_followers
List Followers for a Ticket
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | -------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_list\_ticket\_problems
List Ticket Problems
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | object | No | — | Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both. |
| `per_page` | integer | No | — | Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
| `sort` | string | No | — | Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at` |
| `include_boundary_indicators` | boolean | No | — | When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page\[size], page\[after], page\[before]). |
| `include_item_cursors` | boolean | No | — | When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page\[size], page\[after], page\[before]). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"description": "Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both."
},
"per_page": {
"type": "integer",
"description": "Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
},
"sort": {
"type": "string",
"description": "Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`"
},
"include_boundary_indicators": {
"type": "boolean",
"description": "When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before])."
},
"include_item_cursors": {
"type": "boolean",
"description": "When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before])."
}
},
"required": [
"PCID"
]
}
```
***
## zendesk\_tickets\_list\_ticket\_tags
List Resource Tags
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | -------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_list\_tickets
List Tickets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `external_id` | string | No | — | Lists tickets by external id. External ids don't have to be unique for each ticket. As a result, the request may return multiple tickets with the same external id. |
| `sort_by` | string | No | — | Sort by |
| `sort_order` | string | No | — | Sort order. Defaults to "asc" |
| `support_type_scope` | string | No | — | Lists tickets by support type. Possible values are "all", "agent", or "ai\_agent". Defaults to "agent" |
| `page` | object | No | — | Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both. |
| `per_page` | integer | No | — | Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
| `sort` | string | No | — | Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at` |
| `include` | string | No | — | Sideloads to include in the response. Accepts a comma-separated list of values. See Sideloading. |
| `start_time` | integer | No | — | Unix epoch time to filter tickets. Only tickets created or updated after this time are returned. Example: `?start_time=1332034771` |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"external_id": {
"type": "string",
"description": "Lists tickets by external id. External ids don't have to be unique for each ticket. As a result, the request may return multiple tickets with the same external id."
},
"sort_by": {
"type": "string",
"description": "Sort by",
"enum": [
"id",
"subject",
"deleted_at",
"created_at",
"updated_at",
"status",
"requester",
"requester.name",
"group",
"assignee",
"assignee.name"
]
},
"sort_order": {
"type": "string",
"description": "Sort order. Defaults to \"asc\"",
"enum": [
"asc",
"desc"
]
},
"support_type_scope": {
"type": "string",
"description": "Lists tickets by support type. Possible values are \"all\", \"agent\", or \"ai_agent\". Defaults to \"agent\""
},
"page": {
"description": "Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both."
},
"per_page": {
"type": "integer",
"description": "Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
},
"sort": {
"type": "string",
"description": "Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`"
},
"include": {
"type": "string",
"description": "Sideloads to include in the response. Accepts a comma-separated list of values. See [Sideloading](/api-reference/ticketing/tickets/tickets/#sideloading)."
},
"start_time": {
"type": "integer",
"description": "Unix epoch time to filter tickets. Only tickets created or updated after this time are returned. Example: `?start_time=1332034771`"
}
},
"required": [
"PCID"
]
}
```
***
## zendesk\_tickets\_list\_tickets\_with\_comments
Fetch multiple tickets and their comments in a single call (max 500 ticket IDs). Handles large volumes by chunking ticket fetches (100 per show\_many call) and fetching comments serially to respect Zendesk rate limits. Failed tickets are recorded in metadata but do not abort the batch.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------- | ---------- | -------- | ------- | -------------------------------------------------------------- |
| `ticket_ids` | integer\[] | Yes | — | List of ticket IDs to fetch (max 500) |
| `max_comments_per_ticket` | integer | No | — | Maximum number of comments to return per ticket (default: 100) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of ticket IDs to fetch (max 500)",
"maxItems": 500
},
"max_comments_per_ticket": {
"type": "integer",
"description": "Maximum number of comments to return per ticket (default: 100)"
}
},
"required": [
"PCID",
"ticket_ids"
]
}
```
***
## zendesk\_tickets\_list\_user\_assigned\_tickets
List User Assigned Tickets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------ |
| `user_id` | integer | Yes | — | The id of the user |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "integer",
"description": "The id of the user"
}
},
"required": [
"PCID",
"user_id"
]
}
```
***
## zendesk\_tickets\_list\_user\_requested\_tickets
List User Requested Tickets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `user_id` | integer | Yes | — | The id of the user |
| `sort_by` | string | No | — | Sort by |
| `sort_order` | string | No | — | Sort order. Defaults to "asc" |
| `page` | object | No | — | Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both. |
| `per_page` | integer | No | — | Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
| `include` | string | No | — | Sideloads to include in the response. Accepts a comma-separated list of values. See Sideloading. |
| `exclude_archived` | boolean | No | — | If true, excludes archived tickets from the results. |
| `exclude_count` | boolean | No | — | If true, excludes the total count from the results. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "integer",
"description": "The id of the user"
},
"sort_by": {
"type": "string",
"description": "Sort by",
"enum": [
"id",
"subject",
"deleted_at",
"created_at",
"updated_at",
"status",
"requester",
"requester.name",
"group",
"assignee",
"assignee.name"
]
},
"sort_order": {
"type": "string",
"description": "Sort order. Defaults to \"asc\"",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both."
},
"per_page": {
"type": "integer",
"description": "Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
},
"include": {
"type": "string",
"description": "Sideloads to include in the response. Accepts a comma-separated list of values. See [Sideloading](/api-reference/ticketing/tickets/tickets/#sideloading)."
},
"exclude_archived": {
"type": "boolean",
"description": "If true, excludes archived tickets from the results."
},
"exclude_count": {
"type": "boolean",
"description": "If true, excludes the total count from the results."
}
},
"required": [
"PCID",
"user_id"
]
}
```
***
## zendesk\_tickets\_make\_ticket\_comment\_private
Make Comment Private
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ---------------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
| `ticket_comment_id` | integer | Yes | — | The ID of the ticket comment |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
},
"ticket_comment_id": {
"type": "integer",
"description": "The ID of the ticket comment"
}
},
"required": [
"PCID",
"ticket_id",
"ticket_comment_id"
]
}
```
***
## zendesk\_tickets\_merge\_tickets\_into\_target\_ticket
Merge Tickets into Target Ticket
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ---------- | -------- | ------- | ------------------------------------------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
| `ids` | integer\[] | Yes | — | Ids of tickets to merge into the target ticket |
| `source_comment` | string | No | — | Private comment to add to the source ticket |
| `source_comment_is_public` | boolean | No | — | Whether comment in source tickets are public or private |
| `target_comment` | string | No | — | Private comment to add to the target ticket |
| `target_comment_is_public` | boolean | No | — | Whether comment in target ticket is public or private |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
},
"ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Ids of tickets to merge into the target ticket"
},
"source_comment": {
"type": "string",
"description": "Private comment to add to the source ticket"
},
"source_comment_is_public": {
"type": "boolean",
"description": "Whether comment in source tickets are public or private"
},
"target_comment": {
"type": "string",
"description": "Private comment to add to the target ticket"
},
"target_comment_is_public": {
"type": "boolean",
"description": "Whether comment in target ticket is public or private"
}
},
"required": [
"PCID",
"ticket_id",
"ids"
]
}
```
***
## zendesk\_tickets\_remove\_ticket\_tags
Remove Tags
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ------------------------------------------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
| `tags` | string | No | — | Comma-separated list of tags to remove from the ticket. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
},
"tags": {
"type": "string",
"description": "Comma-separated list of tags to remove from the ticket."
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_restore\_deleted\_ticket
Restore a Previously Deleted Ticket
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | -------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_search
List Search Results
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query` | string | Yes | — | The search query. See Query basics above. For details on the query syntax, see the [Zendesk Support search reference](https://support.zendesk.com/hc/en-us/articles/4408886879258) |
| `sort_by` | string | No | — | One of `updated_at`, `created_at`, `priority`, `status`, or `ticket_type`. Defaults to sorting by relevance |
| `sort_order` | string | No | — | One of `asc` or `desc`. Defaults to `desc` |
| `include` | string | No | — | Sideloads to include in the response. Accepts a comma-separated list of values. The available sideloads depend on the search result types. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"query": {
"type": "string",
"description": "The search query. See [Query basics](#query-basics) above. For details on the query syntax, see the [Zendesk Support search reference](https://support.zendesk.com/hc/en-us/articles/4408886879258)"
},
"sort_by": {
"type": "string",
"description": "One of `updated_at`, `created_at`, `priority`, `status`, or `ticket_type`. Defaults to sorting by relevance"
},
"sort_order": {
"type": "string",
"description": "One of `asc` or `desc`. Defaults to `desc`"
},
"include": {
"type": "string",
"description": "Sideloads to include in the response. Accepts a comma-separated list of values. The available sideloads depend on the search result types."
}
},
"required": [
"PCID",
"query"
]
}
```
***
## zendesk\_tickets\_search\_export
Export Search Results
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query` | string | Yes | — | The search query. See Query basics above. For details on the query syntax, see the [Zendesk Support search reference](https://support.zendesk.com/hc/en-us/articles/4408886879258) |
| `page[size]` | integer | No | — | The number of results shown in a page. |
| `page[after]` | string | No | — | The cursor token for fetching the next page of results. |
| `filter[type]` | string | No | — | The object type returned by the export query. Can be `ticket`, `organization`, `user`, or `group`. |
| `include` | string | No | — | Sideloads to include in the response. Accepts a comma-separated list of values. The available sideloads depend on the search result types. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"query": {
"type": "string",
"description": "The search query. See [Query basics](#query-basics) above. For details on the query syntax, see the [Zendesk Support search reference](https://support.zendesk.com/hc/en-us/articles/4408886879258)"
},
"page[size]": {
"type": "integer",
"description": "The number of results shown in a page."
},
"page[after]": {
"type": "string",
"description": "The cursor token for fetching the next page of results."
},
"filter[type]": {
"type": "string",
"description": "The object type returned by the export query. Can be `ticket`, `organization`, `user`, or `group`."
},
"include": {
"type": "string",
"description": "Sideloads to include in the response. Accepts a comma-separated list of values. The available sideloads depend on the search result types."
}
},
"required": [
"PCID",
"query"
]
}
```
***
## zendesk\_tickets\_set\_ticket\_tags
Set Tags
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | -------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_show\_attachment
Show Attachment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ------------------------ |
| `attachment_id` | integer | Yes | — | The ID of the attachment |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"attachment_id": {
"type": "integer",
"description": "The ID of the attachment"
}
},
"required": [
"PCID",
"attachment_id"
]
}
```
***
## zendesk\_tickets\_show\_many
Show Multiple Tickets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------------------- |
| `ids` | string | Yes | — | Comma-separated list of ticket ids |
| `include` | string | No | — | A comma-separated list of sideloads to include. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "string",
"description": "Comma-separated list of ticket ids"
},
"include": {
"type": "string",
"description": "A comma-separated list of sideloads to include."
}
},
"required": [
"PCID",
"ids"
]
}
```
***
## zendesk\_tickets\_show\_satisfaction\_rating
Show Satisfaction Rating
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | ------- | -------- | ------- | --------------------------------------------- |
| `satisfaction_rating_id` | integer | Yes | — | The id of the satisfaction rating to retrieve |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"satisfaction_rating_id": {
"type": "integer",
"description": "The id of the satisfaction rating to retrieve"
}
},
"required": [
"PCID",
"satisfaction_rating_id"
]
}
```
***
## zendesk\_tickets\_show\_ticket\_metrics\_by\_ticket
Show Ticket Metrics By Ticket
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | -------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_ticket\_related\_information
Ticket Related Information
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | -------------------- |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk\_tickets\_update\_many
Update Many Tickets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------ |
| `ids` | string | No | — | Comma-separated list of ticket ids |
| `body` | object | Yes | — | Ticket object for bulk updates (with ids query parameter) or array of ticket objects for batch updates |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "string",
"description": "Comma-separated list of ticket ids"
},
"body": {
"description": "Ticket object for bulk updates (with ids query parameter) or array of ticket objects for batch updates"
}
},
"required": [
"PCID",
"body"
]
}
```
***
## zendesk\_tickets\_update\_ticket
Update Ticket
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------ |
| `ticket_id` | integer | Yes | — | The ID of the ticket |
| `system_metadata` | object | No | — | System metadata for the request, typically set by internal clients |
| `ticket` | object | No | — | The ticket value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "The ID of the ticket"
},
"system_metadata": {
"type": "object",
"description": "System metadata for the request, typically set by internal clients"
},
"ticket": {
"type": "object",
"description": "The ticket value",
"properties": {
"additional_collaborators": {
"type": "array",
"items": {
"type": "object"
},
"description": "Write only. An array of numeric IDs, emails, or objects containing name and email properties. See [Setting Collaborators](/api-reference/ticketing/tickets/tickets/#setting-collaborators). An email notification is sent to them when the ticket is updated"
},
"allow_attachments": {
"type": "boolean",
"description": "Permission for agents to add add attachments to a comment. Defaults to true"
},
"allow_channelback": {
"type": "boolean",
"description": "Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket"
},
"assignee_email": {
"type": "string",
"description": "Write only. The email address of the agent to assign the ticket to"
},
"assignee_id": {
"type": "integer",
"description": "The agent currently assigned to the ticket"
},
"attribute_value_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Write only. An array of the IDs of attribute values to be associated with the ticket"
},
"brand_id": {
"type": "integer",
"description": "The id of the brand this ticket is associated with. See [Setting up multiple brands](https://support.zendesk.com/hc/en-us/articles/4408829476378)"
},
"collaborator_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The ids of users currently CC'ed on the ticket"
},
"collaborators": {
"type": "array",
"items": {
"type": "object"
},
"description": "Write only. Users to add as cc's when creating a ticket. See [Setting Collaborators](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#setting-collaborators)"
},
"comment": {
"type": "object",
"description": "The comment value"
},
"created_at": {
"type": "string",
"description": "When this record was created"
},
"custom_fields": {
"type": "array",
"items": {
"type": "object"
},
"description": "Custom field values to set on the ticket. Each entry specifies a field ID and its value. See [Setting custom field values](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#setting-custom-field-values)"
},
"custom_status_id": {
"type": "integer",
"description": "The custom ticket status id of the ticket. See [custom ticket statuses](#custom-ticket-statuses)"
},
"description": {
"type": "string",
"description": "The first comment on the ticket. When [creating a ticket](#create-ticket), use `comment` to set the description. See [Description and first comment](#description-and-first-comment). On create, can be set directly as an alternative to `comment`. Silently ignored on update."
},
"due_at": {
"type": "string",
"description": "If this is a ticket of type \"task\" it has a due date. Due date format uses [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format"
},
"email_cc_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The ids of agents or end users currently CC'ed on the ticket. See [CCs and followers resources](https://support.zendesk.com/hc/en-us/articles/4408822451482) in the Support Help Center"
},
"email_ccs": {
"type": "array",
"items": {
"type": "object"
},
"description": "Write only. An array of objects that represent agent or end users email CCs to add or delete from the ticket. See [Setting email CCs](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#setting-email-ccs). Ignored when [CCs and followers](https://support.zendesk.com/hc/en-us/articles/4408822451482) is not enabled"
},
"encoded_id": {
"type": "string",
"description": "An encoded string representing the ticket's unique identifier"
},
"external_id": {
"type": "string",
"description": "An id you can use to link Zendesk Support tickets to local records"
},
"fields": {
"type": "array",
"items": {
"type": "object"
},
"description": "Alias for custom_fields. Custom field values to set on the ticket. Each entry specifies a field ID and its value."
},
"follower_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The ids of agents currently following the ticket. Ignored when [CCs and followers](https://support.zendesk.com/hc/en-us/articles/4408822451482) is not enabled"
},
"followers": {
"type": "array",
"items": {
"type": "object"
},
"description": "Write only. An array of objects that represents agent followers to add or delete from the ticket. See [Setting followers](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#setting-followers). Ignored when [CCs and followers](https://support.zendesk.com/hc/en-us/articles/4408822451482) is not enabled"
},
"followup_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The ids of the followups created from this ticket. Ids are only visible once the ticket is closed"
},
"forum_topic_id": {
"type": "integer",
"description": "The topic in the Zendesk Web portal this ticket originated from, if any. The Web portal is deprecated"
},
"from_messaging_channel": {
"type": "boolean",
"description": "If true, the ticket's [via type](/documentation/ticketing/reference-guides/via-object-reference/) is a messaging channel."
},
"generated_timestamp": {
"type": "integer",
"description": "A Unix timestamp that represents the most accurate reading of when this record was last updated. It is updated for all ticket updates, including system updates"
},
"group_id": {
"type": "integer",
"description": "The group this ticket is assigned to"
},
"has_incidents": {
"type": "boolean",
"description": "Is true if a ticket is a problem type and has one or more incidents linked to it. Otherwise, the value is false."
},
"id": {
"type": "integer",
"description": "Automatically assigned when the ticket is created"
},
"is_public": {
"type": "boolean",
"description": "Is true if any comments are public, false otherwise"
},
"macro_id": {
"type": "integer",
"description": "Write only. A single macro ID to be recorded in the ticket audit"
},
"macro_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Write only. List of macro IDs to be recorded in the ticket audit"
},
"metadata": {
"type": "object",
"description": "Write only. Metadata for the audit. In the `audit` object, the data is specified in the `custom` property of the `metadata` object. See [Setting Metadata](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#setting-metadata)"
},
"organization_id": {
"type": "integer",
"description": "The organization of the requester. You can only specify the ID of an organization associated with the requester. See [Organization Memberships](/api-reference/ticketing/organizations/organization_memberships/)"
},
"origin_zrn": {
"type": "string",
"description": "Write only. The Zendesk Resource Name (ZRN) of the origin for this ticket"
},
"priority": {
"type": "string",
"description": "The urgency with which the ticket should be addressed",
"enum": [
"urgent",
"high",
"normal",
"low"
]
},
"problem_id": {
"type": "integer",
"description": "For tickets of type \"incident\", the ID of the problem the incident is linked to"
},
"raw_subject": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"subject\" value, if not. See [Dynamic Content Items](/api-reference/ticketing/ticket-management/dynamic_content/). When set on create or update, overrides the `subject` field."
},
"recipient": {
"type": "string",
"description": "The original recipient e-mail address of the ticket. Notification emails for the ticket are sent from this address"
},
"requester": {
"description": "Write only. Alternative to requester_id for specifying the ticket requester. Can be provided as: - Email string: \"user@example.com\" - User ID integer: 12345 - User object: {name: \"John Doe\", email: \"john@example.com\"} If both requester and requester_id are provided, requester_id takes precedence. When creating a ticket, if the user doesn't exist, they may be created automatically depending on account settings."
},
"requester_id": {
"type": "integer",
"description": "The user who requested this ticket"
},
"safe_update": {
"type": "boolean",
"description": "Write only. Optional boolean. When true and an `updated_stamp` date is included, protects against ticket update collisions and returns a message to let you know if one occurs. See [Protecting against ticket update collisions](/documentation/ticketing/managing-tickets/creating-and-updating-tickets/#protecting-against-ticket-update-collisions). A value of false has the same effect as true. Omit the property to force the updates to not be safe"
},
"satisfaction_probability": {
"type": "number",
"description": "The predicted satisfaction probability score"
},
"satisfaction_rating": {
"type": "object",
"description": "The satisfaction rating of the ticket, if it exists, or the state of satisfaction, \"offered\" or \"unoffered\". The value is null for plan types that don't support CSAT"
},
"sharing_agreement_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "An array of the numeric IDs of sharing agreements. Note that this replaces any existing agreements"
},
"sharing_agreements": {
"type": "array",
"items": {
"type": "object"
},
"description": "Write only. Sharing agreement configuration for the ticket. Accepts a single object or an array of objects."
},
"status": {
"type": "string",
"description": "The state of the ticket. If your account has activated custom ticket statuses, this is the ticket's status category. See [custom ticket statuses](#custom-ticket-statuses)",
"enum": [
"new",
"open",
"pending",
"hold",
"solved",
"closed"
]
},
"subject": {
"type": "string",
"description": "The value of the subject field for this ticket. See [Subject](/api-reference/ticketing/tickets/tickets/#subject)"
},
"submitter_id": {
"type": "integer",
"description": "The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket. If not specified, defaults to the authenticated user."
},
"support_type": {
"type": "string",
"description": "The type of support that handled the ticket",
"enum": [
"agent",
"ai_agent"
]
},
"suspended_ticket_id": {
"type": "integer",
"description": "Write only. The ID of the suspended ticket being recovered"
},
"suspension_type_id": {
"type": "integer",
"description": "Write only. The suspension type ID when recovering a suspended ticket"
},
"system_metadata": {
"type": "object",
"description": "Write only. System metadata for the ticket, typically set by internal clients"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags applied to this ticket. Unless otherwise specified, the [set tag](/api-reference/ticketing/ticket-management/tags/#set-tags) behavior is used, which overwrites and replaces existing tags"
},
"tde_workspace": {
"type": "object",
"description": "Write only. TDE workspace information for the ticket"
},
"ticket_form_id": {
"type": "integer",
"description": "Enterprise only. The id of the ticket form to render for the ticket"
},
"tpe_voice_comment": {
"type": "object",
"description": "Write only. A TPE voice comment for Talk Partner Edition tickets"
},
"type": {
"type": "string",
"description": "The type of this ticket",
"enum": [
"problem",
"incident",
"question",
"task"
]
},
"updated_at": {
"type": "string",
"description": "When this record last got updated. It is updated only if the update generates a [ticket event](#incremental-ticket-event-export)"
},
"updated_stamp": {
"type": "string",
"description": "Write only. Datetime of last update received from API. See the `safe_update` property"
},
"url": {
"type": "string",
"description": "The API url of this ticket"
},
"via": {
"type": "object",
"description": "An object explaining how the ticket was created. See the [Via object reference](/documentation/ticketing/reference-guides/via-object-reference)"
},
"via_followup_source_id": {
"type": "integer",
"description": "Write only. The id of a closed ticket when creating a follow-up ticket. See [Creating a follow-up ticket](/documentation/ticketing/managing-tickets/creating-and-updating-tickets#creating-a-follow-up-ticket)"
},
"via_id": {
"type": "integer",
"description": "Write only. For more information, see the [Via object reference](/documentation/ticketing/reference-guides/via-object-reference/)"
},
"voice_comment": {
"type": "object",
"description": "Write only. A voice comment for Talk tickets. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets/)"
}
}
}
},
"required": [
"PCID",
"ticket_id"
]
}
```
***
## zendesk-tickets\_bulk\_recover\_suspended\_tickets
Bulk Recover Suspended Tickets
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------- |
| `ids` | string | Yes | — | Comma-separated list of suspended ticket IDs to recover |
| `author` | object | No | — | The author value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "string",
"description": "Comma-separated list of suspended ticket IDs to recover"
},
"author": {
"type": "object",
"description": "The author value",
"properties": {
"email": {
"type": "string",
"description": "Email address to identify the author"
},
"id": {
"type": "integer",
"description": "User ID to set as the author of recovered tickets"
}
}
}
},
"required": [
"PCID",
"ids"
]
}
```
***
## zendesk-tickets\_create\_saved\_search
Create Saved Search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------- |
| `filters` | string | No | — | A JSON-stringified array of filter field IDs to persist alongside the search. Optional. |
| `name` | string | Yes | — | The name given by the agent to the saved search. Must be 255 characters or less. |
| `query` | string | Yes | — | The search query string. Must be 2000 characters or less. |
| `type` | string | Yes | — | The type of object the search applies to |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filters": {
"type": "string",
"description": "A JSON-stringified array of filter field IDs to persist alongside the search. Optional."
},
"name": {
"type": "string",
"description": "The name given by the agent to the saved search. Must be 255 characters or less."
},
"query": {
"type": "string",
"description": "The search query string. Must be 2000 characters or less."
},
"type": {
"type": "string",
"description": "The type of object the search applies to",
"enum": [
"ticket",
"user",
"organization",
"side_conversation",
"article"
]
}
},
"required": [
"PCID",
"name",
"query",
"type"
]
}
```
***
## zendesk-tickets\_delete\_saved\_search
Delete Saved Search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------- |
| `id` | string | Yes | — | The UUID of the saved search |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The UUID of the saved search"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## zendesk-tickets\_list\_saved\_searches
List Saved Searches
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## zendesk-tickets\_update\_saved\_search
Update Saved Search
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The UUID of the saved search |
| `filters` | string | No | — | A JSON-stringified array of filter field IDs to persist alongside the search. Optional. |
| `name` | string | Yes | — | The name given by the agent to the saved search. Must be 255 characters or less. |
| `query` | string | Yes | — | The search query string. Must be 2000 characters or less. |
| `type` | string | Yes | — | The type of object the search applies to |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The UUID of the saved search"
},
"filters": {
"type": "string",
"description": "A JSON-stringified array of filter field IDs to persist alongside the search. Optional."
},
"name": {
"type": "string",
"description": "The name given by the agent to the saved search. Must be 255 characters or less."
},
"query": {
"type": "string",
"description": "The search query string. Must be 2000 characters or less."
},
"type": {
"type": "string",
"description": "The type of object the search applies to",
"enum": [
"ticket",
"user",
"organization",
"side_conversation",
"article"
]
}
},
"required": [
"PCID",
"id",
"name",
"query",
"type"
]
}
```