> ## 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-admin > Zendesk Admin — macros, triggers, automations, views, and configuration **Server path:** `/zendesk-admin` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------- | --------------------------- | | [`zendesk_admin_create_automation`](#zendesk_admin_create_automation) | Create Automation | | [`zendesk_admin_create_macro`](#zendesk_admin_create_macro) | Create Macro | | [`zendesk_admin_create_trigger`](#zendesk_admin_create_trigger) | Create Trigger | | [`zendesk_admin_create_view`](#zendesk_admin_create_view) | Create View | | [`zendesk_admin_delete_automation`](#zendesk_admin_delete_automation) | Delete Automation | | [`zendesk_admin_delete_macro`](#zendesk_admin_delete_macro) | Delete Macro | | [`zendesk_admin_delete_trigger`](#zendesk_admin_delete_trigger) | Delete Ticket Trigger | | [`zendesk_admin_delete_view`](#zendesk_admin_delete_view) | Delete View | | [`zendesk_admin_execute_view`](#zendesk_admin_execute_view) | Execute View | | [`zendesk_admin_get_automation`](#zendesk_admin_get_automation) | Show Automation | | [`zendesk_admin_get_custom_status`](#zendesk_admin_get_custom_status) | Show Custom Ticket Status | | [`zendesk_admin_get_macro`](#zendesk_admin_get_macro) | Show Macro | | [`zendesk_admin_get_ticket_field`](#zendesk_admin_get_ticket_field) | Show Ticket Field | | [`zendesk_admin_get_ticket_form`](#zendesk_admin_get_ticket_form) | Show Ticket Form | | [`zendesk_admin_get_trigger`](#zendesk_admin_get_trigger) | Show Ticket Trigger | | [`zendesk_admin_get_view`](#zendesk_admin_get_view) | Show View | | [`zendesk_admin_list_automations`](#zendesk_admin_list_automations) | List Automations | | [`zendesk_admin_list_custom_statuses`](#zendesk_admin_list_custom_statuses) | List Custom Ticket Statuses | | [`zendesk_admin_list_macros`](#zendesk_admin_list_macros) | List Macros | | [`zendesk_admin_list_ticket_fields`](#zendesk_admin_list_ticket_fields) | List Ticket Fields | | [`zendesk_admin_list_ticket_forms`](#zendesk_admin_list_ticket_forms) | List Ticket Forms | | [`zendesk_admin_list_tickets_from_view`](#zendesk_admin_list_tickets_from_view) | List Tickets From a View | | [`zendesk_admin_list_triggers`](#zendesk_admin_list_triggers) | List Ticket Triggers | | [`zendesk_admin_list_views`](#zendesk_admin_list_views) | List Views | | [`zendesk_admin_search_automations`](#zendesk_admin_search_automations) | Search Automations | | [`zendesk_admin_search_macro`](#zendesk_admin_search_macro) | Search Macros | | [`zendesk_admin_search_macros`](#zendesk_admin_search_macros) | Search Macros | | [`zendesk_admin_search_triggers`](#zendesk_admin_search_triggers) | Search Ticket Triggers | | [`zendesk_admin_search_views`](#zendesk_admin_search_views) | Search Views | | [`zendesk_admin_show_changes_to_ticket`](#zendesk_admin_show_changes_to_ticket) | Show Changes to Ticket | | [`zendesk_admin_update_automation`](#zendesk_admin_update_automation) | Update Automation | | [`zendesk_admin_update_macro`](#zendesk_admin_update_macro) | Update Macro | | [`zendesk_admin_update_trigger`](#zendesk_admin_update_trigger) | Update Ticket Trigger | | [`zendesk_admin_update_view`](#zendesk_admin_update_view) | Update View | | [`zendesk-admin_get_account_email_settings`](#zendesk-admin_get_account_email_settings) | Show Email Settings | | [`zendesk-admin_update_account_email_settings`](#zendesk-admin_update_account_email_settings) | Update Email Settings | *** ## zendesk\_admin\_create\_automation Create Automation ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## zendesk\_admin\_create\_macro Create Macro **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------- | | `macro` | object | No | — | The macro value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "macro": { "type": "object", "description": "The macro value", "properties": { "actions": { "type": "array", "items": { "type": "object" }, "description": "Each action describes what the macro will do" }, "active": { "type": "boolean", "description": "Useful for determining if the macro should be displayed" }, "description": { "type": "string", "description": "The description of the macro" }, "restriction": { "type": "object", "description": "Who may access this macro. Will be null when everyone in the account can access it" }, "title": { "type": "string", "description": "The title of the macro" } }, "required": [ "title", "actions" ] } }, "required": [ "PCID" ] } ``` *** ## zendesk\_admin\_create\_trigger Create Trigger **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------- | | `trigger` | object | No | — | The trigger value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "trigger": { "type": "object", "description": "The trigger value", "properties": { "actions": { "type": "array", "items": { "type": "object" }, "description": "An array of actions describing what the ticket trigger will do. See [Actions reference](/documentation/ticketing/reference-guides/actions-reference)" }, "active": { "type": "boolean", "description": "Whether the ticket trigger is active" }, "all": { "type": "array", "items": { "type": "object" }, "description": "Legacy format for conditions (deprecated). Use conditions.all instead" }, "any": { "type": "array", "items": { "type": "object" }, "description": "Legacy format for conditions (deprecated). Use conditions.any instead" }, "brand_id": { "type": "integer", "description": "The ID of the brand the ticket trigger belongs to" }, "category": { "type": "object", "description": "A category to create and assign to the trigger" }, "category_id": { "type": "string", "description": "The ID of the category the ticket trigger belongs to" }, "conditions": { "type": "object", "description": "An object that describes the circumstances under which the trigger performs its actions. See [Conditions reference](/documentation/ticketing/reference-guides/conditions-reference)" }, "created_at": { "type": "string", "description": "The time the ticket trigger was created" }, "default": { "type": "boolean", "description": "If true, the ticket trigger is a standard trigger" }, "description": { "type": "string", "description": "The description of the ticket trigger" }, "id": { "type": "integer", "description": "Automatically assigned when created" }, "position": { "type": "integer", "description": "Position of the ticket trigger, determines the order they will execute in" }, "raw_title": { "type": "string", "description": "The raw format of the title of the ticket trigger" }, "restriction": { "type": "object", "description": "Access restriction for this trigger. A null value allows unrestricted access" }, "title": { "type": "string", "description": "The title of the ticket trigger" }, "updated_at": { "type": "string", "description": "The time of the last update of the ticket trigger" }, "url": { "type": "string", "description": "The url of the ticket trigger" } }, "required": [ "actions", "title" ] } }, "required": [ "PCID" ] } ``` *** ## zendesk\_admin\_create\_view Create View ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## zendesk\_admin\_delete\_automation Delete Automation **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ------------------------ | | `automation_id` | integer | Yes | — | The ID of the automation | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "automation_id": { "type": "integer", "description": "The ID of the automation" } }, "required": [ "PCID", "automation_id" ] } ``` *** ## zendesk\_admin\_delete\_macro Delete Macro **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ------------------- | | `macro_id` | integer | Yes | — | The ID of the macro | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "macro_id": { "type": "integer", "description": "The ID of the macro" } }, "required": [ "PCID", "macro_id" ] } ``` *** ## zendesk\_admin\_delete\_trigger Delete Ticket Trigger **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | --------------------- | | `trigger_id` | integer | Yes | — | The ID of the trigger | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "trigger_id": { "type": "integer", "description": "The ID of the trigger" } }, "required": [ "PCID", "trigger_id" ] } ``` *** ## zendesk\_admin\_delete\_view Delete View **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------ | | `view_id` | integer | Yes | — | The ID of the view | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "view_id": { "type": "integer", "description": "The ID of the view" } }, "required": [ "PCID", "view_id" ] } ``` *** ## zendesk\_admin\_execute\_view Execute View **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `view_id` | integer | Yes | — | The ID of the view | | `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. | | `sort_by` | string | No | — | The ticket field used for sorting. This will either be a title or a custom field id. | | `sort_order` | string | No | — | The direction the tickets are sorted. May be one of 'asc' or 'desc' | | `include` | string | No | — | A comma-separated list of sideloads to include in the response. | | `exclude` | string | No | — | A comma-separated list of sideloads to exclude from the response. | | `group_by` | string | No | — | The ticket field used for grouping. This will either be a title or a custom field id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "view_id": { "type": "integer", "description": "The ID of the view" }, "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." }, "sort_by": { "type": "string", "description": "The ticket field used for sorting. This will either be a title or a custom field id." }, "sort_order": { "type": "string", "description": "The direction the tickets are sorted. May be one of 'asc' or 'desc'" }, "include": { "type": "string", "description": "A comma-separated list of sideloads to include in the response." }, "exclude": { "type": "string", "description": "A comma-separated list of sideloads to exclude from the response." }, "group_by": { "type": "string", "description": "The ticket field used for grouping. This will either be a title or a custom field id." } }, "required": [ "PCID", "view_id" ] } ``` *** ## zendesk\_admin\_get\_automation Show Automation **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ------------------------ | | `automation_id` | integer | Yes | — | The ID of the automation | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "automation_id": { "type": "integer", "description": "The ID of the automation" } }, "required": [ "PCID", "automation_id" ] } ``` *** ## zendesk\_admin\_get\_custom\_status Show Custom Ticket Status **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | --------------------------- | | `custom_status_id` | integer | Yes | — | The id of the custom status | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "custom_status_id": { "type": "integer", "description": "The id of the custom status" } }, "required": [ "PCID", "custom_status_id" ] } ``` *** ## zendesk\_admin\_get\_macro Show Macro **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ------------------- | | `macro_id` | integer | Yes | — | The ID of the macro | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "macro_id": { "type": "integer", "description": "The ID of the macro" } }, "required": [ "PCID", "macro_id" ] } ``` *** ## zendesk\_admin\_get\_ticket\_field Show Ticket Field **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ticket_field_id` | integer | Yes | — | The ID of the ticket field | | `creator` | boolean | No | — | If true, displays the `creator_user_id` and `creator_app_name` properties. If the ticket field is created by an app, `creator_app_name` is the name of the app and `creator_user_id` is `-1`. If the ticket field is not created by an app, then `creator_app_name` is null | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ticket_field_id": { "type": "integer", "description": "The ID of the ticket field" }, "creator": { "type": "boolean", "description": "If true, displays the `creator_user_id` and `creator_app_name` properties. If the ticket field is created by an app, `creator_app_name` is the name of the app and `creator_user_id` is `-1`. If the ticket field is not created by an app, then `creator_app_name` is null" } }, "required": [ "PCID", "ticket_field_id" ] } ``` *** ## zendesk\_admin\_get\_ticket\_form Show Ticket Form **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------- | -------- | ------- | ------------------------- | | `ticket_form_id` | integer | Yes | — | The ID of the ticket form | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "ticket_form_id": { "type": "integer", "description": "The ID of the ticket form" } }, "required": [ "PCID", "ticket_form_id" ] } ``` *** ## zendesk\_admin\_get\_trigger Show Ticket Trigger **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | --------------------- | | `trigger_id` | integer | Yes | — | The ID of the trigger | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "trigger_id": { "type": "integer", "description": "The ID of the trigger" } }, "required": [ "PCID", "trigger_id" ] } ``` *** ## zendesk\_admin\_get\_view Show View **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------------------------------------------------------- | | `view_id` | integer | Yes | — | The ID of the view | | `include` | string | No | — | A comma-separated list of sideloads to include in the response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "view_id": { "type": "integer", "description": "The ID of the view" }, "include": { "type": "string", "description": "A comma-separated list of sideloads to include in the response." } }, "required": [ "PCID", "view_id" ] } ``` *** ## zendesk\_admin\_list\_automations List Automations **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` | | `active` | boolean | No | — | Filter by active automations if true or inactive automations if false | | `include` | string | No | — | A sideload to include in the response. See Sideloads | ```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`" }, "active": { "type": "boolean", "description": "Filter by active automations if true or inactive automations if false" }, "include": { "type": "string", "description": "A sideload to include in the response. See [Sideloads](#sideloads-2)" } }, "required": [ "PCID" ] } ``` *** ## zendesk\_admin\_list\_custom\_statuses List Custom Ticket Statuses **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `status_categories` | string | No | — | Filter the list of custom ticket statuses by a comma-separated list of status categories | | `active` | boolean | No | — | If true, show only active custom ticket statuses. If false, show only inactive custom ticket statuses. If the filter is not used, show all custom ticket statuses | | `default` | boolean | No | — | If true, show only default custom ticket statuses. If false, show only non-default custom ticket statuses. If the filter is not used, show all custom ticket statuses | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "status_categories": { "type": "string", "description": "Filter the list of custom ticket statuses by a comma-separated list of status categories" }, "active": { "type": "boolean", "description": "If true, show only active custom ticket statuses. If false, show only inactive custom ticket statuses. If the filter is not used, show all custom ticket statuses" }, "default": { "type": "boolean", "description": "If true, show only default custom ticket statuses. If false, show only non-default custom ticket statuses. If the filter is not used, show all custom ticket statuses" } }, "required": [ "PCID" ] } ``` *** ## zendesk\_admin\_list\_macros List Macros **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `include` | string | No | — | A sideload to include in the response. See Sideloads | | `access` | string | No | — | Filter macros by access. Possible values are "personal", "agents", "shared", or "account". The "agents" value returns all personal macros for the account's agents and is only available to admins. | | `active` | boolean | No | — | Filter by active macros if true or inactive macros if false | | `category` | integer | No | — | Filter macros by category | | `group_id` | integer | No | — | Filter macros by group | | `only_viewable` | boolean | No | — | If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false | | `sort_by` | string | No | — | Possible values are "alphabetical", "created\_at", "updated\_at", "usage\_1h", "usage\_24h", "usage\_7d", or "usage\_30d". Defaults to alphabetical | | `sort_order` | string | No | — | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | | `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" }, "include": { "type": "string", "description": "A sideload to include in the response. See [Sideloads](#sideloads-2)" }, "access": { "type": "string", "description": "Filter macros by access. Possible values are \"personal\", \"agents\", \"shared\", or \"account\". The \"agents\" value returns all personal macros for the account's agents and is only available to admins." }, "active": { "type": "boolean", "description": "Filter by active macros if true or inactive macros if false" }, "category": { "type": "integer", "description": "Filter macros by category" }, "group_id": { "type": "integer", "description": "Filter macros by group" }, "only_viewable": { "type": "boolean", "description": "If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false" }, "sort_by": { "type": "string", "description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", \"usage_7d\", or \"usage_30d\". Defaults to alphabetical" }, "sort_order": { "type": "string", "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others" }, "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\_admin\_list\_ticket\_fields List Ticket Fields **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `locale` | string | No | — | Forces the `title_in_portal` property to return a dynamic content variant for the specified locale. Only accepts active locale ids. Example: `locale="de"`. | | `creator` | boolean | No | — | Displays the `creator_user_id` and `creator_app_name` properties. If the ticket field is created by an app, `creator_app_name` is the name of the app and `creator_user_id` is `-1`. If the ticket field is not created by an app, `creator_app_name` is null | | `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` | | `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" }, "locale": { "type": "string", "description": "Forces the `title_in_portal` property to return a dynamic content variant for the specified locale. Only accepts [active locale ids](/api-reference/ticketing/account-configuration/locales/#list-locales). Example: `locale=\"de\"`." }, "creator": { "type": "boolean", "description": "Displays the `creator_user_id` and `creator_app_name` properties. If the ticket field is created by an app, `creator_app_name` is the name of the app and `creator_user_id` is `-1`. If the ticket field is not created by an app, `creator_app_name` is null" }, "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" } } }, "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\_admin\_list\_ticket\_forms List Ticket Forms **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `active` | boolean | No | — | true returns active ticket forms; false returns inactive ticket forms. If not present, returns both | | `end_user_visible` | boolean | No | — | true returns ticket forms where `end_user_visible`; false returns ticket forms that are not end-user visible. If not present, returns both | | `fallback_to_default` | boolean | No | — | true returns the default ticket form when the criteria defined by the parameters results in a set without active and end-user visible ticket forms | | `form_type` | string | No | — | Filter ticket forms by type. Use 'standard' for regular ticket forms, 'service\_catalog' for service catalog forms, or 'all' to return all form types | | `associated_to_brand` | boolean | No | — | true returns the ticket forms of the brand specified by the url's subdomain | | `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]). | | `locale` | string | No | — | Locale to use for the ticket form names. If not specified, the default locale is used. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "active": { "type": "boolean", "description": "true returns active ticket forms; false returns inactive ticket forms. If not present, returns both" }, "end_user_visible": { "type": "boolean", "description": "true returns ticket forms where `end_user_visible`; false returns ticket forms that are not end-user visible. If not present, returns both" }, "fallback_to_default": { "type": "boolean", "description": "true returns the default ticket form when the criteria defined by the parameters results in a set without active and end-user visible ticket forms" }, "form_type": { "type": "string", "description": "Filter ticket forms by type. Use 'standard' for regular ticket forms, 'service_catalog' for service catalog forms, or 'all' to return all form types", "enum": [ "standard", "service_catalog", "all" ] }, "associated_to_brand": { "type": "boolean", "description": "true returns the ticket forms of the brand specified by the url's subdomain" }, "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])." }, "locale": { "type": "string", "description": "Locale to use for the ticket form names. If not specified, the default locale is used." } }, "required": [ "PCID" ] } ``` *** ## zendesk\_admin\_list\_tickets\_from\_view List Tickets From a View **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ | | `view_id` | integer | Yes | — | The ID of the view | | `sort_by` | string | No | — | Sort or group the tickets by a column in the View columns table. The `subject` and `submitter` columns are not supported | | `sort_order` | string | No | — | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "view_id": { "type": "integer", "description": "The ID of the view" }, "sort_by": { "type": "string", "description": "Sort or group the tickets by a column in the [View columns](#view-columns) table. The `subject` and `submitter` columns are not supported" }, "sort_order": { "type": "string", "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others" } }, "required": [ "PCID", "view_id" ] } ``` *** ## zendesk\_admin\_list\_triggers List Ticket Triggers **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `active` | boolean | No | — | Filter by active triggers if true or inactive triggers if false | | `sort` | string | No | — | Cursor-based pagination only. Possible values are "alphabetical", "created\_at", "updated\_at", or "position". | | `sort_by` | string | No | — | Offset pagination only. Possible values are "alphabetical", "created\_at", "updated\_at", "usage\_1h", "usage\_24h", or "usage\_7d". Defaults to "position" | | `sort_order` | string | No | — | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | | `category_id` | string | No | — | Filter triggers by category ID | | `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 | — | A sideload to include in the response. See Sideloads | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "active": { "type": "boolean", "description": "Filter by active triggers if true or inactive triggers if false" }, "sort": { "type": "string", "description": "Cursor-based pagination only. Possible values are \"alphabetical\", \"created_at\", \"updated_at\", or \"position\"." }, "sort_by": { "type": "string", "description": "Offset pagination only. Possible values are \"alphabetical\", \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", or \"usage_7d\". Defaults to \"position\"" }, "sort_order": { "type": "string", "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others" }, "category_id": { "type": "string", "description": "Filter triggers by category ID" }, "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": "A sideload to include in the response. See [Sideloads](#sideloads-2)" } }, "required": [ "PCID" ] } ``` *** ## zendesk\_admin\_list\_views List Views **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `access` | string | No | — | Only views with given access. May be "personal", "shared", or "account" | | `active` | boolean | No | — | Only active views if true, inactive views if false | | `group_id` | integer | No | — | Only views belonging to given group | | `sort` | string | No | — | The sort parameter used with cursor pagination. Defaults to "created\_at". Prefix with '-' for descending order | | `sort_by` | string | No | — | The sort\_by parameter used with offset pagination. Possible values are "alphabetical", "created\_at", or "updated\_at". Defaults to "position" | | `sort_order` | string | No | — | The sort\_order parameter used with offset pagination. One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | | `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" }, "access": { "type": "string", "description": "Only views with given access. May be \"personal\", \"shared\", or \"account\"" }, "active": { "type": "boolean", "description": "Only active views if true, inactive views if false" }, "group_id": { "type": "integer", "description": "Only views belonging to given group" }, "sort": { "type": "string", "description": "The sort parameter used with cursor pagination. Defaults to \"created_at\". Prefix with '-' for descending order" }, "sort_by": { "type": "string", "description": "The sort_by parameter used with offset pagination. Possible values are \"alphabetical\", \"created_at\", or \"updated_at\". Defaults to \"position\"" }, "sort_order": { "type": "string", "description": "The sort_order parameter used with offset pagination. One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others" }, "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\_admin\_search\_automations Search Automations **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `query` | string | Yes | — | Query string used to find all automations with matching title | | `active` | boolean | No | — | Filter by active automations if true or inactive automations if false | | `sort_by` | string | No | — | Possible values are "alphabetical", "created\_at", "updated\_at", and "position". If unspecified, the automations are sorted by relevance | | `sort_order` | string | No | — | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | | `include` | string | No | — | A sideload to include in the response. See Sideloads | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "Query string used to find all automations with matching title" }, "active": { "type": "boolean", "description": "Filter by active automations if true or inactive automations if false" }, "sort_by": { "type": "string", "description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", and \"position\". If unspecified, the automations are sorted by relevance" }, "sort_order": { "type": "string", "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others" }, "include": { "type": "string", "description": "A sideload to include in the response. See [Sideloads](#sideloads-2)" } }, "required": [ "PCID", "query" ] } ``` *** ## zendesk\_admin\_search\_macro Search Macros **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `include` | string | No | — | A sideload to include in the response. See Sideloads | | `access` | string | No | — | Filter macros by access. Possible values are "personal", "agents", "shared", or "account". The "agents" value returns all personal macros for the account's agents and is only available to admins. | | `active` | boolean | No | — | Filter by active macros if true or inactive macros if false | | `category` | integer | No | — | Filter macros by category | | `group_id` | integer | No | — | Filter macros by group | | `only_viewable` | boolean | No | — | If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false | | `sort_by` | string | No | — | Possible values are "alphabetical", "created\_at", "updated\_at", or "position". Defaults to alphabetical | | `sort_order` | string | No | — | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | | `query` | string | Yes | — | Query string used to find macros with matching titles | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "include": { "type": "string", "description": "A sideload to include in the response. See [Sideloads](#sideloads-2)" }, "access": { "type": "string", "description": "Filter macros by access. Possible values are \"personal\", \"agents\", \"shared\", or \"account\". The \"agents\" value returns all personal macros for the account's agents and is only available to admins." }, "active": { "type": "boolean", "description": "Filter by active macros if true or inactive macros if false" }, "category": { "type": "integer", "description": "Filter macros by category" }, "group_id": { "type": "integer", "description": "Filter macros by group" }, "only_viewable": { "type": "boolean", "description": "If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false" }, "sort_by": { "type": "string", "description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", or \"position\". Defaults to alphabetical" }, "sort_order": { "type": "string", "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others" }, "query": { "type": "string", "description": "Query string used to find macros with matching titles" } }, "required": [ "PCID", "query" ] } ``` *** ## zendesk\_admin\_search\_macros Search Macros **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `include` | string | No | — | A sideload to include in the response. See Sideloads | | `access` | string | No | — | Filter macros by access. Possible values are "personal", "agents", "shared", or "account". The "agents" value returns all personal macros for the account's agents and is only available to admins. | | `active` | boolean | No | — | Filter by active macros if true or inactive macros if false | | `category` | integer | No | — | Filter macros by category | | `group_id` | integer | No | — | Filter macros by group | | `only_viewable` | boolean | No | — | If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false | | `sort_by` | string | No | — | Possible values are "alphabetical", "created\_at", "updated\_at", or "position". Defaults to alphabetical | | `sort_order` | string | No | — | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | | `query` | string | Yes | — | Query string used to find macros with matching titles | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "include": { "type": "string", "description": "A sideload to include in the response. See [Sideloads](#sideloads-2)" }, "access": { "type": "string", "description": "Filter macros by access. Possible values are \"personal\", \"agents\", \"shared\", or \"account\". The \"agents\" value returns all personal macros for the account's agents and is only available to admins." }, "active": { "type": "boolean", "description": "Filter by active macros if true or inactive macros if false" }, "category": { "type": "integer", "description": "Filter macros by category" }, "group_id": { "type": "integer", "description": "Filter macros by group" }, "only_viewable": { "type": "boolean", "description": "If true, returns only macros that can be applied to tickets. If false, returns all macros the current user can manage. Default is false" }, "sort_by": { "type": "string", "description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", or \"position\". Defaults to alphabetical" }, "sort_order": { "type": "string", "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others" }, "query": { "type": "string", "description": "Query string used to find macros with matching titles" } }, "required": [ "PCID", "query" ] } ``` *** ## zendesk\_admin\_search\_triggers Search Ticket Triggers **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | `query` | string | No | — | Query string used to find all triggers with matching title | | `filter` | string | No | — | JSON-encoded trigger attribute filters for the search. See Filter. Example: `{"json":{"description":"Close a ticket"}}` | | `active` | boolean | No | — | Filter by active triggers if true or inactive triggers if false | | `sort` | string | No | — | Cursor-based pagination only. Possible values are "alphabetical", "created\_at", "updated\_at", or "position". | | `sort_by` | string | No | — | Offset pagination only. Possible values are "alphabetical", "created\_at", "updated\_at", "usage\_1h", "usage\_24h", or "usage\_7d". Defaults to "position" | | `sort_order` | string | No | — | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | | `include` | string | No | — | A sideload to include in the response. See Sideloads | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "Query string used to find all triggers with matching title" }, "filter": { "type": "string", "description": "JSON-encoded trigger attribute filters for the search. See [Filter](#filter). Example: `{\"json\":{\"description\":\"Close a ticket\"}}`" }, "active": { "type": "boolean", "description": "Filter by active triggers if true or inactive triggers if false" }, "sort": { "type": "string", "description": "Cursor-based pagination only. Possible values are \"alphabetical\", \"created_at\", \"updated_at\", or \"position\"." }, "sort_by": { "type": "string", "description": "Offset pagination only. Possible values are \"alphabetical\", \"created_at\", \"updated_at\", \"usage_1h\", \"usage_24h\", or \"usage_7d\". Defaults to \"position\"" }, "sort_order": { "type": "string", "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others" }, "include": { "type": "string", "description": "A sideload to include in the response. See [Sideloads](#sideloads-2)" } }, "required": [ "PCID" ] } ``` *** ## zendesk\_admin\_search\_views Search Views **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `query` | string | Yes | — | Query string used to find all views with matching title | | `access` | string | No | — | Filter views by access. May be "personal", "shared", or "account" | | `active` | boolean | No | — | Filter by active views if true or inactive views if false | | `group_id` | integer | No | — | Filter views by group | | `sort_by` | string | No | — | Possible values are "alphabetical", "created\_at", "updated\_at", and "position". If unspecified, the views are sorted by relevance | | `sort_order` | string | No | — | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others | | `include` | string | No | — | A sideload to include in the response. See Sideloads | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "query": { "type": "string", "description": "Query string used to find all views with matching title" }, "access": { "type": "string", "description": "Filter views by access. May be \"personal\", \"shared\", or \"account\"" }, "active": { "type": "boolean", "description": "Filter by active views if true or inactive views if false" }, "group_id": { "type": "integer", "description": "Filter views by group" }, "sort_by": { "type": "string", "description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", and \"position\". If unspecified, the views are sorted by relevance" }, "sort_order": { "type": "string", "description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others" }, "include": { "type": "string", "description": "A sideload to include in the response. See [Sideloads](#sideloads-3)" } }, "required": [ "PCID", "query" ] } ``` *** ## zendesk\_admin\_show\_changes\_to\_ticket Show Changes to Ticket **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `macro_id` | integer | Yes | — | The ID of the macro | | `normalize_comment` | boolean | No | — | If true, normalizes the newline formatting of the macro's comment to more closely match the formatting produced by the ticket comment editor | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "macro_id": { "type": "integer", "description": "The ID of the macro" }, "normalize_comment": { "type": "boolean", "description": "If true, normalizes the newline formatting of the macro's comment to more closely match the formatting produced by the ticket comment editor" } }, "required": [ "PCID", "macro_id" ] } ``` *** ## zendesk\_admin\_update\_automation Update Automation **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | ------------------------ | | `automation_id` | integer | Yes | — | The ID of the automation | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "automation_id": { "type": "integer", "description": "The ID of the automation" } }, "required": [ "PCID", "automation_id" ] } ``` *** ## zendesk\_admin\_update\_macro Update Macro **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ------------------- | | `macro_id` | integer | Yes | — | The ID of the macro | | `macro` | object | No | — | The macro value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "macro_id": { "type": "integer", "description": "The ID of the macro" }, "macro": { "type": "object", "description": "The macro value", "properties": { "actions": { "type": "array", "items": { "type": "object" }, "description": "Each action describes what the macro will do" }, "active": { "type": "boolean", "description": "Useful for determining if the macro should be displayed" }, "description": { "type": "string", "description": "The description of the macro" }, "restriction": { "type": "object", "description": "Who may access this macro. Will be null when everyone in the account can access it" }, "title": { "type": "string", "description": "The title of the macro" } }, "required": [ "title", "actions" ] } }, "required": [ "PCID", "macro_id" ] } ``` *** ## zendesk\_admin\_update\_trigger Update Ticket Trigger **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | --------------------- | | `trigger_id` | integer | Yes | — | The ID of the trigger | | `trigger` | object | No | — | The trigger value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "trigger_id": { "type": "integer", "description": "The ID of the trigger" }, "trigger": { "type": "object", "description": "The trigger value", "properties": { "actions": { "type": "array", "items": { "type": "object" }, "description": "An array of actions describing what the ticket trigger will do. See [Actions reference](/documentation/ticketing/reference-guides/actions-reference)" }, "active": { "type": "boolean", "description": "Whether the ticket trigger is active" }, "all": { "type": "array", "items": { "type": "object" }, "description": "Legacy format for conditions (deprecated). Use conditions.all instead" }, "any": { "type": "array", "items": { "type": "object" }, "description": "Legacy format for conditions (deprecated). Use conditions.any instead" }, "brand_id": { "type": "integer", "description": "The ID of the brand the ticket trigger belongs to" }, "category": { "type": "object", "description": "A category to create and assign to the trigger" }, "category_id": { "type": "string", "description": "The ID of the category the ticket trigger belongs to" }, "conditions": { "type": "object", "description": "An object that describes the circumstances under which the trigger performs its actions. See [Conditions reference](/documentation/ticketing/reference-guides/conditions-reference)" }, "created_at": { "type": "string", "description": "The time the ticket trigger was created" }, "default": { "type": "boolean", "description": "If true, the ticket trigger is a standard trigger" }, "description": { "type": "string", "description": "The description of the ticket trigger" }, "id": { "type": "integer", "description": "Automatically assigned when created" }, "position": { "type": "integer", "description": "Position of the ticket trigger, determines the order they will execute in" }, "raw_title": { "type": "string", "description": "The raw format of the title of the ticket trigger" }, "restriction": { "type": "object", "description": "Access restriction for this trigger. A null value allows unrestricted access" }, "title": { "type": "string", "description": "The title of the ticket trigger" }, "updated_at": { "type": "string", "description": "The time of the last update of the ticket trigger" }, "url": { "type": "string", "description": "The url of the ticket trigger" } }, "required": [ "actions", "title" ] } }, "required": [ "PCID", "trigger_id" ] } ``` *** ## zendesk\_admin\_update\_view Update View **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------ | | `view_id` | integer | Yes | — | The ID of the view | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "view_id": { "type": "integer", "description": "The ID of the view" } }, "required": [ "PCID", "view_id" ] } ``` *** ## zendesk-admin\_get\_account\_email\_settings Show Email Settings ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## zendesk-admin\_update\_account\_email\_settings Update Email Settings **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------ | | `settings` | object | Yes | — | The settings value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "settings": { "type": "object", "description": "The settings value", "properties": { "email": { "type": "object", "description": "Email settings" } }, "required": [ "email" ] } }, "required": [ "PCID", "settings" ] } ```