gorgias-admin

Gorgias Admin - manage account, users, teams, rules, macros, views, integrations, and widgets

Server path: /gorgias-admin | Type: Application | PCID required: Yes

Tools

Tool	Description
gorgias_admin_bulk_archive_macros	Archive macros
gorgias_admin_bulk_unarchive_macros	Unarchive macros
gorgias_admin_cancel_job	Cancel a job
gorgias_admin_create_account_setting	Create a setting
gorgias_admin_create_integration	Create an integration
gorgias_admin_create_job	Create a job
gorgias_admin_create_macro	Create a macro
gorgias_admin_create_rule	Create a rule
gorgias_admin_create_team	Create a team
gorgias_admin_create_user	Create a user
gorgias_admin_create_view	Create a view
gorgias_admin_create_widget	Create a widget
gorgias_admin_delete_integration	Delete an integration
gorgias_admin_delete_macro	Delete a macro
gorgias_admin_delete_rule	Delete a rule
gorgias_admin_delete_team	Delete a team
gorgias_admin_delete_user	Delete a user
gorgias_admin_delete_view	Delete a view
gorgias_admin_delete_widget	Delete a widget
gorgias_admin_get_account	Retrieve your account
gorgias_admin_get_integration	Retrieve an integration
gorgias_admin_get_job	Retrieve a job
gorgias_admin_get_macro	Retrieve a macro
gorgias_admin_get_rule	Retrieve a rule
gorgias_admin_get_team	Retrieve a team
gorgias_admin_get_user	Retrieve a user
gorgias_admin_get_view	Retrieve a view
gorgias_admin_get_widget	Retrieve a widget
gorgias_admin_list_account_settings	List settings
gorgias_admin_list_integrations	List integrations
gorgias_admin_list_jobs	List jobs
gorgias_admin_list_macros	List macros
gorgias_admin_list_rules	List rules
gorgias_admin_list_teams	List teams
gorgias_admin_list_users	List users
gorgias_admin_list_view_items	List view’s items
gorgias_admin_list_views	List views
gorgias_admin_list_widgets	List widgets
gorgias_admin_update_account_setting	Update a setting
gorgias_admin_update_integration	Update an integration
gorgias_admin_update_job	Update a job
gorgias_admin_update_macro	Update a macro
gorgias_admin_update_rule	Update a rule
gorgias_admin_update_rules_priorities	Update rules’ priorities
gorgias_admin_update_team	Update a team
gorgias_admin_update_user	Update a user
gorgias_admin_update_view	Update a view
gorgias_admin_update_view_items	Search for view’s items
gorgias_admin_update_widget	Update a widget

---

gorgias_admin_bulk_archive_macros

Archive macros

Parameters:

Parameter	Type	Required	Default	Description
ids	integer[]	Yes	—	List of macro ids to be archived

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "List of macro ids to be archived"
    }
  },
  "required": [
    "PCID",
    "ids"
  ]
}

---

gorgias_admin_bulk_unarchive_macros

Unarchive macros

Parameters:

Parameter	Type	Required	Default	Description
ids	integer[]	Yes	—	List of macro ids to be unarchived

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "List of macro ids to be unarchived"
    }
  },
  "required": [
    "PCID",
    "ids"
  ]
}

---

gorgias_admin_cancel_job

Cancel a job

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the job to cancel.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the job to cancel."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_create_account_setting

Create a setting

Parameters:

Parameter	Type	Required	Default	Description
data	object	No	—	The data value
type	string	Yes	—	The type value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "data": {
      "description": "The data value"
    },
    "type": {
      "type": "string",
      "description": "The type value"
    }
  },
  "required": [
    "PCID",
    "type"
  ]
}

---

gorgias_admin_create_integration

Create an integration

Parameters:

Parameter	Type	Required	Default	Description
deactivated_datetime	string	null	No	—	When the integration was deactivated.
description	string	null	No	—	Description about the integration.
http	object	No	—	Only available for HTTP integrations, defines the configuration of the integration.
managed	boolean	No	—	Whether integration is managed by Gorgias.
name	string	Yes	—	Name of the integration. Usually the email address, Facebook page name, etc.
type	string	Yes	—	Type of integration.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deactivated_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the integration was deactivated."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Description about the integration."
    },
    "http": {
      "type": "object",
      "description": "Only available for HTTP integrations, defines the configuration of the integration.",
      "properties": {
        "form": {
          "type": "object",
          "description": "Data to send to the external service. It can either be a raw JSON object (if `request_content_type` is `application/json`) or a key-value object representing form data (if `request_content_type` is `application/x-www-form-urlencoded`). You can use variables like {{ticket.customer.email}} as values for the request. Check all properties from a [customer](#the-customer-object), or review the list of [Gorgias variables](https://docs.gorgias.com/macros/macro-variables#gorgias_variables) for inspiration."
        },
        "headers": {
          "type": "object",
          "description": "HTTP headers expected by the external service."
        },
        "hmac_secret": {
          "type": "string",
          "description": "The HMAC secret to use to sign HTTP calls to the external service."
        },
        "method": {
          "type": "string",
          "description": "HTTP method expected by the external service.",
          "enum": [
            "GET",
            "POST",
            "PUT",
            "DELETE",
            "HEAD",
            "PATCH"
          ]
        },
        "request_content_type": {
          "type": "string",
          "description": "Content type of the outgoing request to the external service.",
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded"
          ]
        },
        "response_content_type": {
          "type": "string",
          "description": "Content type of the incoming response from the external service.",
          "enum": [
            "application/json"
          ]
        },
        "triggers": {
          "type": "object",
          "description": "Events that will trigger the request to the external service."
        },
        "url": {
          "type": "string",
          "description": "URL of the external service. You can use variables like {{ticket.customer.email}} to pass customer data to the integration. Check all properties from a [customer](#the-customer-object), or review the list of [Gorgias variables](https://docs.gorgias.com/macros/macro-variables#gorgias_variables) for inspiration."
        }
      },
      "required": [
        "method",
        "request_content_type",
        "response_content_type",
        "url"
      ]
    },
    "managed": {
      "type": "boolean",
      "description": "Whether integration is managed by Gorgias."
    },
    "name": {
      "type": "string",
      "description": "Name of the integration. Usually the email address, Facebook page name, etc."
    },
    "type": {
      "type": "string",
      "description": "Type of integration.",
      "enum": [
        "http"
      ]
    }
  },
  "required": [
    "PCID",
    "name",
    "type"
  ]
}

---

gorgias_admin_create_job

Create a job

Parameters:

Parameter	Type	Required	Default	Description
meta	object	No	—	Metadata associated with the job. You can use this parameter to store structured information (key-value data) about the job. This field is not used by Gorgias.
params	object	Yes	—	The parameters of the job.
scheduled_datetime	string	null	No	—	When the job was scheduled to be started. A job cannot be scheduled more than 60 minutes in the future. If unspecified, the job is queued for execution immediately after creation.
type	string	Yes	—	The type of the job. Options: applyMacro, deleteTicket, exportTicket, importMacro, exportMacro, updateTicket, exportTicketDrilldown, exportConvertCampaignSalesDrilldown

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "meta": {
      "type": "object",
      "description": "Metadata associated with the job. You can use this parameter to store structured information (key-value data) about the job. This field is not used by Gorgias."
    },
    "params": {
      "type": "object",
      "description": "The parameters of the job.",
      "properties": {
        "apply_and_close": {
          "type": "boolean",
          "description": "Whether the ticket should be closed once the macro is applied on it. Only applies to `applyMacro` jobs."
        },
        "context": {
          "type": "object",
          "description": "Object (key-value) containing extra context for the job"
        },
        "end_datetime": {
          "type": "string",
          "description": "End of the interval from which to select tickets when the parameter `view` is used."
        },
        "macro_id": {
          "type": "integer",
          "description": "The ID of the macro to apply on the selected tickets. Only applies to `applyMacro` jobs."
        },
        "start_datetime": {
          "type": "string",
          "description": "Beginning of the interval from which to select tickets when the parameter `view` is used."
        },
        "ticket_ids": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "A list of ticket IDs to be processed by the job."
        },
        "updates": {
          "type": "object",
          "description": "Object (key-value) containing all the changes to apply on the selected tickets. Only applies to `updateTicket` jobs."
        },
        "url": {
          "type": "string",
          "description": "The path to the file to import."
        },
        "view": {
          "type": "object",
          "description": "A [view](#the-view-object)-like object used to select the tickets to be processed by the job."
        },
        "view_id": {
          "type": "integer",
          "description": "The ID of an existing [view](#the-view-object) used to select the tickets to be processed by the job."
        }
      }
    },
    "scheduled_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the job was scheduled to be started. A job cannot be scheduled more than 60 minutes in the future. If unspecified, the job is queued for execution immediately after creation."
    },
    "type": {
      "type": "string",
      "description": "The type of the job. Options: applyMacro, deleteTicket, exportTicket, importMacro, exportMacro, updateTicket, exportTicketDrilldown, exportConvertCampaignSalesDrilldown",
      "enum": [
        "applyMacro",
        "deleteTicket",
        "exportTicket",
        "importMacro",
        "exportMacro",
        "updateTicket",
        "exportTicketDrilldown",
        "exportConvertCampaignSalesDrilldown"
      ]
    }
  },
  "required": [
    "PCID",
    "params",
    "type"
  ]
}

---

gorgias_admin_create_macro

Create a macro

Parameters:

Parameter	Type	Required	Default	Description
actions	object[]	No	—	A list of actions to be applied on tickets.
external_id	string	null	No	—	External ID of the macro in a foreign system. This field is not used by Gorgias, feel free to set it to your own value.
intent	string	null	No	—	The intention of the macro should be used for.
language	string	null	No	—	The language of the macro in ISO 639-1 format.
name	string	Yes	—	The name of the Macro. Tips: choose a name that can be easily searched.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "arguments": {
            "type": "object",
            "description": "Parameters of the action. These parameters vary according to the name of the action."
          },
          "description": {
            "type": "string",
            "description": "Description of what the action does."
          },
          "name": {
            "type": "string",
            "description": "The name of the action."
          },
          "title": {
            "type": "string",
            "description": "The title of the action."
          },
          "type": {
            "type": "string",
            "enum": [
              "system",
              "user"
            ],
            "description": "The type of action."
          }
        },
        "required": [
          "arguments",
          "name",
          "title"
        ]
      },
      "description": "A list of [actions](#the-macroaction-object) to be applied on tickets."
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "External ID of the macro in a foreign system. This field is not used by Gorgias, feel free to set it to your own value."
    },
    "intent": {
      "type": [
        "string",
        "null"
      ],
      "description": "The intention of the macro should be used for.",
      "enum": [
        "discount/request",
        "exchange/request",
        "exchange/status",
        "feedback",
        "order/damaged",
        "order/cancel",
        "order/change",
        "order/wrong",
        "other/no_reply",
        "other/question",
        "other/thanks",
        "product/recommendation",
        "product/question",
        "refund/request",
        "refund/status",
        "return/request",
        "return/status",
        "shipping/change",
        "shipping/delivery-issue",
        "shipping/policy",
        "shipping/status",
        "stock/request",
        "subscription/cancel",
        "subscription/change"
      ]
    },
    "language": {
      "type": [
        "string",
        "null"
      ],
      "description": "The language of the macro in ISO 639-1 format."
    },
    "name": {
      "type": "string",
      "description": "The name of the Macro. Tips: choose a name that can be easily searched."
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

---

gorgias_admin_create_rule

Create a rule

Parameters:

Parameter	Type	Required	Default	Description
code	string	Yes	—	The logic of the rule (as JavaScript code).
code_ast	object	No	—	The logic of the rule (as an ESTree AST representation). Generated from the code if not specified.
deactivated_datetime	string	null	No	—	When the rule was deactivated.
description	string	null	No	—	The description of the rule.
event_types	string	No	—	A list of comma separated events that this rule will be executed on. Valid values: ticket-created, ticket-updated, ticket-message-created, ticket-assigned, ticket-self-unsnoozed, satisfaction-survey-responded.
name	string	Yes	—	The name of the rule.
priority	integer	No	—	Order of execution of the rule. Rules with higher priorities are executed first.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "code": {
      "type": "string",
      "description": "The logic of the rule (as JavaScript code)."
    },
    "code_ast": {
      "type": "object",
      "description": "The logic of the rule (as an ESTree [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) representation). Generated from the code if not specified."
    },
    "deactivated_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the rule was deactivated."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The description of the rule."
    },
    "event_types": {
      "type": "string",
      "description": "A list of comma separated events that this rule will be executed on. Valid values: ticket-created, ticket-updated, ticket-message-created, ticket-assigned, ticket-self-unsnoozed, satisfaction-survey-responded."
    },
    "name": {
      "type": "string",
      "description": "The name of the rule."
    },
    "priority": {
      "type": "integer",
      "description": "Order of execution of the rule. Rules with higher priorities are executed first."
    }
  },
  "required": [
    "PCID",
    "code",
    "name"
  ]
}

---

gorgias_admin_create_team

Create a team

Parameters:

Parameter	Type	Required	Default	Description
decoration	object	No	—	Object describing how the team appears on the webpage. Currently only supports emoji field that shows before the team’s name.
description	string	null	No	—	Longer description of the team.
members	object[]	No	—	The list of users within the team.
name	string	Yes	—	Name of the team.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "decoration": {
      "type": "object",
      "description": "Object describing how the team appears on the webpage. Currently only supports `emoji` field that shows before the team's name."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Longer description of the team."
    },
    "members": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "description": "The email address of the user"
          },
          "id": {
            "type": "integer",
            "description": "ID of the object"
          },
          "meta": {
            "type": "object",
            "description": "User defined JSON field. It can be useful for storing additional info about the object."
          },
          "name": {
            "type": "string",
            "description": "The full name of the user"
          }
        }
      },
      "description": "The list of users within the team."
    },
    "name": {
      "type": "string",
      "description": "Name of the team."
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

---

gorgias_admin_create_user

Create a user

Parameters:

Parameter	Type	Required	Default	Description
bio	string	null	No	—	Short biography of the user.
country	string	null	No	—	Country of the user
email	string	Yes	—	Email address of the user. password_confirmation field must be provided to change the email.
external_id	string	No	—	ID of the user in a foreign system (Stripe, Aircall, etc…). This field is not used by Gorgias, feel free to set it as you wish.
language	string	null	No	—	The language value
meta	object	No	—	Data associated with the user. You can use this field to store structured information (key-value data) about the user.
name	string	Yes	—	Full name of the user.
role	object	Yes	—	The role of the user.
timezone	string	No	—	Timezone identifier

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "bio": {
      "type": [
        "string",
        "null"
      ],
      "description": "Short biography of the user."
    },
    "country": {
      "type": [
        "string",
        "null"
      ],
      "description": "Country of the user"
    },
    "email": {
      "type": "string",
      "description": "Email address of the user. `password_confirmation` field must be provided to change the email."
    },
    "external_id": {
      "type": "string",
      "description": "ID of the user in a foreign system (Stripe, Aircall, etc...). This field is not used by Gorgias, feel free to set it as you wish."
    },
    "language": {
      "type": [
        "string",
        "null"
      ],
      "description": "The language value",
      "enum": [
        "fr",
        "en"
      ]
    },
    "meta": {
      "type": "object",
      "description": "Data associated with the user. You can use this field to store structured information (key-value data) about the user.",
      "properties": {
        "profile_picture_url": {
          "type": "string",
          "description": "URL of the profile picture of the user"
        },
        "sso": {
          "type": "string",
          "description": "Name of the Single Sign-On provider the user can use to log in",
          "enum": [
            "google",
            "office365"
          ]
        }
      }
    },
    "name": {
      "type": "string",
      "description": "Full name of the user."
    },
    "role": {
      "type": "object",
      "description": "The role of the user.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the role",
          "enum": [
            "admin",
            "agent",
            "basic-agent",
            "lite-agent",
            "observer-agent"
          ]
        }
      },
      "required": [
        "name"
      ]
    },
    "timezone": {
      "type": "string",
      "description": "Timezone identifier",
      "enum": [
        "Africa/Abidjan",
        "Africa/Accra",
        "Africa/Addis_Ababa",
        "Africa/Algiers",
        "Africa/Asmara",
        "Africa/Asmera",
        "Africa/Bamako",
        "Africa/Bangui",
        "Africa/Banjul",
        "Africa/Bissau",
        "Africa/Blantyre",
        "Africa/Brazzaville",
        "Africa/Bujumbura",
        "Africa/Cairo",
        "Africa/Casablanca",
        "Africa/Ceuta",
        "Africa/Conakry",
        "Africa/Dakar",
        "Africa/Dar_es_Salaam",
        "Africa/Djibouti",
        "Africa/Douala",
        "Africa/El_Aaiun",
        "Africa/Freetown",
        "Africa/Gaborone",
        "Africa/Harare",
        "Africa/Johannesburg",
        "Africa/Juba",
        "Africa/Kampala",
        "Africa/Khartoum",
        "Africa/Kigali",
        "Africa/Kinshasa",
        "Africa/Lagos",
        "Africa/Libreville",
        "Africa/Lome",
        "Africa/Luanda",
        "Africa/Lubumbashi",
        "Africa/Lusaka",
        "Africa/Malabo",
        "Africa/Maputo",
        "Africa/Maseru",
        "Africa/Mbabane",
        "Africa/Mogadishu",
        "Africa/Monrovia",
        "Africa/Nairobi",
        "Africa/Ndjamena",
        "Africa/Niamey",
        "Africa/Nouakchott",
        "Africa/Ouagadougou",
        "Africa/Porto-Novo",
        "Africa/Sao_Tome",
        "Africa/Timbuktu",
        "Africa/Tripoli",
        "Africa/Tunis",
        "Africa/Windhoek",
        "America/Adak",
        "America/Anchorage",
        "America/Anguilla",
        "America/Antigua",
        "America/Araguaina",
        "America/Argentina/Buenos_Aires",
        "America/Argentina/Catamarca",
        "America/Argentina/ComodRivadavia",
        "America/Argentina/Cordoba",
        "America/Argentina/Jujuy",
        "America/Argentina/La_Rioja",
        "America/Argentina/Mendoza",
        "America/Argentina/Rio_Gallegos",
        "America/Argentina/Salta",
        "America/Argentina/San_Juan",
        "America/Argentina/San_Luis",
        "America/Argentina/Tucuman",
        "America/Argentina/Ushuaia",
        "America/Aruba",
        "America/Asuncion",
        "America/Atikokan",
        "America/Atka",
        "America/Bahia",
        "America/Bahia_Banderas",
        "America/Barbados",
        "America/Belem",
        "America/Belize",
        "America/Blanc-Sablon",
        "America/Boa_Vista",
        "America/Bogota",
        "America/Boise",
        "America/Buenos_Aires",
        "America/Cambridge_Bay",
        "America/Campo_Grande",
        "America/Cancun",
        "America/Caracas",
        "America/Catamarca",
        "America/Cayenne",
        "America/Cayman",
        "America/Chicago",
        "America/Chihuahua",
        "America/Coral_Harbour",
        "America/Cordoba",
        "America/Costa_Rica",
        "America/Creston",
        "America/Cuiaba",
        "America/Curacao",
        "America/Danmarkshavn",
        "America/Dawson",
        "America/Dawson_Creek",
        "America/Denver",
        "America/Detroit",
        "America/Dominica",
        "America/Edmonton",
        "America/Eirunepe",
        "America/El_Salvador",
        "America/Ensenada",
        "America/Fort_Nelson",
        "America/Fort_Wayne",
        "America/Fortaleza",
        "America/Glace_Bay",
        "America/Godthab",
        "America/Goose_Bay",
        "America/Grand_Turk",
        "America/Grenada",
        "America/Guadeloupe",
        "America/Guatemala",
        "America/Guayaquil",
        "America/Guyana",
        "America/Halifax",
        "America/Havana",
        "America/Hermosillo",
        "America/Indiana/Indianapolis",
        "America/Indiana/Knox",
        "America/Indiana/Marengo",
        "America/Indiana/Petersburg",
        "America/Indiana/Tell_City",
        "America/Indiana/Vevay",
        "America/Indiana/Vincennes",
        "America/Indiana/Winamac",
        "America/Indianapolis",
        "America/Inuvik",
        "America/Iqaluit",
        "America/Jamaica",
        "America/Jujuy",
        "America/Juneau",
        "America/Kentucky/Louisville",
        "America/Kentucky/Monticello",
        "America/Knox_IN",
        "America/Kralendijk",
        "America/La_Paz",
        "America/Lima",
        "America/Los_Angeles",
        "America/Louisville",
        "America/Lower_Princes",
        "America/Maceio",
        "America/Managua",
        "America/Manaus",
        "America/Marigot",
        "America/Martinique",
        "America/Matamoros",
        "America/Mazatlan",
        "America/Mendoza",
        "America/Menominee",
        "America/Merida",
        "America/Metlakatla",
        "America/Mexico_City",
        "America/Miquelon",
        "America/Moncton",
        "America/Monterrey",
        "America/Montevideo",
        "America/Montreal",
        "America/Montserrat",
        "America/Nassau",
        "America/New_York",
        "America/Nipigon",
        "America/Nome",
        "America/Noronha",
        "America/North_Dakota/Beulah",
        "America/North_Dakota/Center",
        "America/North_Dakota/New_Salem",
        "America/Nuuk",
        "America/Ojinaga",
        "America/Panama",
        "America/Pangnirtung",
        "America/Paramaribo",
        "America/Phoenix",
        "America/Port-au-Prince",
        "America/Port_of_Spain",
        "America/Porto_Acre",
        "America/Porto_Velho",
        "America/Puerto_Rico",
        "America/Punta_Arenas",
        "America/Rainy_River",
        "America/Rankin_Inlet",
        "America/Recife",
        "America/Regina",
        "America/Resolute",
        "America/Rio_Branco",
        "America/Rosario",
        "America/Santa_Isabel",
        "America/Santarem",
        "America/Santiago",
        "America/Santo_Domingo",
        "America/Sao_Paulo",
        "America/Scoresbysund",
        "America/Shiprock",
        "America/Sitka",
        "America/St_Barthelemy",
        "America/St_Johns",
        "America/St_Kitts",
        "America/St_Lucia",
        "America/St_Thomas",
        "America/St_Vincent",
        "America/Swift_Current",
        "America/Tegucigalpa",
        "America/Thule",
        "America/Thunder_Bay",
        "America/Tijuana",
        "America/Toronto",
        "America/Tortola",
        "America/Vancouver",
        "America/Virgin",
        "America/Whitehorse",
        "America/Winnipeg",
        "America/Yakutat",
        "America/Yellowknife",
        "Antarctica/Casey",
        "Antarctica/Davis",
        "Antarctica/DumontDUrville",
        "Antarctica/Macquarie",
        "Antarctica/Mawson",
        "Antarctica/McMurdo",
        "Antarctica/Palmer",
        "Antarctica/Rothera",
        "Antarctica/South_Pole",
        "Antarctica/Syowa",
        "Antarctica/Troll",
        "Antarctica/Vostok",
        "Arctic/Longyearbyen",
        "Asia/Aden",
        "Asia/Almaty",
        "Asia/Amman",
        "Asia/Anadyr",
        "Asia/Aqtau",
        "Asia/Aqtobe",
        "Asia/Ashgabat",
        "Asia/Ashkhabad",
        "Asia/Atyrau",
        "Asia/Baghdad",
        "Asia/Bahrain",
        "Asia/Baku",
        "Asia/Bangkok",
        "Asia/Barnaul",
        "Asia/Beirut",
        "Asia/Bishkek",
        "Asia/Brunei",
        "Asia/Calcutta",
        "Asia/Chita",
        "Asia/Choibalsan",
        "Asia/Chongqing",
        "Asia/Chungking",
        "Asia/Colombo",
        "Asia/Dacca",
        "Asia/Damascus",
        "Asia/Dhaka",
        "Asia/Dili",
        "Asia/Dubai",
        "Asia/Dushanbe",
        "Asia/Famagusta",
        "Asia/Gaza",
        "Asia/Harbin",
        "Asia/Hebron",
        "Asia/Ho_Chi_Minh",
        "Asia/Hong_Kong",
        "Asia/Hovd",
        "Asia/Irkutsk",
        "Asia/Istanbul",
        "Asia/Jakarta",
        "Asia/Jayapura",
        "Asia/Jerusalem",
        "Asia/Kabul",
        "Asia/Kamchatka",
        "Asia/Karachi",
        "Asia/Kashgar",
        "Asia/Kathmandu",
        "Asia/Katmandu",
        "Asia/Khandyga",
        "Asia/Kolkata",
        "Asia/Krasnoyarsk",
        "Asia/Kuala_Lumpur",
        "Asia/Kuching",
        "Asia/Kuwait",
        "Asia/Macao",
        "Asia/Macau",
        "Asia/Magadan",
        "Asia/Makassar",
        "Asia/Manila",
        "Asia/Muscat",
        "Asia/Nicosia",
        "Asia/Novokuznetsk",
        "Asia/Novosibirsk",
        "Asia/Omsk",
        "Asia/Oral",
        "Asia/Phnom_Penh",
        "Asia/Pontianak",
        "Asia/Pyongyang",
        "Asia/Qatar",
        "Asia/Qostanay",
        "Asia/Qyzylorda",
        "Asia/Rangoon",
        "Asia/Riyadh",
        "Asia/Saigon",
        "Asia/Sakhalin",
        "Asia/Samarkand",
        "Asia/Seoul",
        "Asia/Shanghai",
        "Asia/Singapore",
        "Asia/Srednekolymsk",
        "Asia/Taipei",
        "Asia/Tashkent",
        "Asia/Tbilisi",
        "Asia/Tehran",
        "Asia/Tel_Aviv",
        "Asia/Thimbu",
        "Asia/Thimphu",
        "Asia/Tokyo",
        "Asia/Tomsk",
        "Asia/Ujung_Pandang",
        "Asia/Ulaanbaatar",
        "Asia/Ulan_Bator",
        "Asia/Urumqi",
        "Asia/Ust-Nera",
        "Asia/Vientiane",
        "Asia/Vladivostok",
        "Asia/Yakutsk",
        "Asia/Yangon",
        "Asia/Yekaterinburg",
        "Asia/Yerevan",
        "Atlantic/Azores",
        "Atlantic/Bermuda",
        "Atlantic/Canary",
        "Atlantic/Cape_Verde",
        "Atlantic/Faeroe",
        "Atlantic/Faroe",
        "Atlantic/Jan_Mayen",
        "Atlantic/Madeira",
        "Atlantic/Reykjavik",
        "Atlantic/South_Georgia",
        "Atlantic/St_Helena",
        "Atlantic/Stanley",
        "Australia/ACT",
        "Australia/Adelaide",
        "Australia/Brisbane",
        "Australia/Broken_Hill",
        "Australia/Canberra",
        "Australia/Currie",
        "Australia/Darwin",
        "Australia/Eucla",
        "Australia/Hobart",
        "Australia/LHI",
        "Australia/Lindeman",
        "Australia/Lord_Howe",
        "Australia/Melbourne",
        "Australia/NSW",
        "Australia/North",
        "Australia/Perth",
        "Australia/Queensland",
        "Australia/South",
        "Australia/Sydney",
        "Australia/Tasmania",
        "Australia/Victoria",
        "Australia/West",
        "Australia/Yancowinna",
        "Brazil/Acre",
        "Brazil/DeNoronha",
        "Brazil/East",
        "Brazil/West",
        "CET",
        "CST6CDT",
        "Canada/Atlantic",
        "Canada/Central",
        "Canada/Eastern",
        "Canada/Mountain",
        "Canada/Newfoundland",
        "Canada/Pacific",
        "Canada/Saskatchewan",
        "Canada/Yukon",
        "Chile/Continental",
        "Chile/EasterIsland",
        "Cuba",
        "EET",
        "EST",
        "EST5EDT",
        "Egypt",
        "Eire",
        "Etc/GMT",
        "Etc/GMT+0",
        "Etc/GMT+1",
        "Etc/GMT+10",
        "Etc/GMT+11",
        "Etc/GMT+12",
        "Etc/GMT+2",
        "Etc/GMT+3",
        "Etc/GMT+4",
        "Etc/GMT+5",
        "Etc/GMT+6",
        "Etc/GMT+7",
        "Etc/GMT+8",
        "Etc/GMT+9",
        "Etc/GMT-0",
        "Etc/GMT-1",
        "Etc/GMT-10",
        "Etc/GMT-11",
        "Etc/GMT-12",
        "Etc/GMT-13",
        "Etc/GMT-14",
        "Etc/GMT-2",
        "Etc/GMT-3",
        "Etc/GMT-4",
        "Etc/GMT-5",
        "Etc/GMT-6",
        "Etc/GMT-7",
        "Etc/GMT-8",
        "Etc/GMT-9",
        "Etc/GMT0",
        "Etc/Greenwich",
        "Etc/UCT",
        "Etc/UTC",
        "Etc/Universal",
        "Etc/Zulu",
        "Europe/Amsterdam",
        "Europe/Andorra",
        "Europe/Astrakhan",
        "Europe/Athens",
        "Europe/Belfast",
        "Europe/Belgrade",
        "Europe/Berlin",
        "Europe/Bratislava",
        "Europe/Brussels",
        "Europe/Bucharest",
        "Europe/Budapest",
        "Europe/Busingen",
        "Europe/Chisinau",
        "Europe/Copenhagen",
        "Europe/Dublin",
        "Europe/Gibraltar",
        "Europe/Guernsey",
        "Europe/Helsinki",
        "Europe/Isle_of_Man",
        "Europe/Istanbul",
        "Europe/Jersey",
        "Europe/Kaliningrad",
        "Europe/Kiev",
        "Europe/Kirov",
        "Europe/Kyiv",
        "Europe/Lisbon",
        "Europe/Ljubljana",
        "Europe/London",
        "Europe/Luxembourg",
        "Europe/Madrid",
        "Europe/Malta",
        "Europe/Mariehamn",
        "Europe/Minsk",
        "Europe/Monaco",
        "Europe/Moscow",
        "Europe/Nicosia",
        "Europe/Oslo",
        "Europe/Paris",
        "Europe/Podgorica",
        "Europe/Prague",
        "Europe/Riga",
        "Europe/Rome",
        "Europe/Samara",
        "Europe/San_Marino",
        "Europe/Sarajevo",
        "Europe/Saratov",
        "Europe/Simferopol",
        "Europe/Skopje",
        "Europe/Sofia",
        "Europe/Stockholm",
        "Europe/Tallinn",
        "Europe/Tirane",
        "Europe/Tiraspol",
        "Europe/Ulyanovsk",
        "Europe/Uzhgorod",
        "Europe/Vaduz",
        "Europe/Vatican",
        "Europe/Vienna",
        "Europe/Vilnius",
        "Europe/Volgograd",
        "Europe/Warsaw",
        "Europe/Zagreb",
        "Europe/Zaporozhye",
        "Europe/Zurich",
        "GB",
        "GB-Eire",
        "GMT",
        "GMT+0",
        "GMT-0",
        "GMT0",
        "Greenwich",
        "HST",
        "Hongkong",
        "Iceland",
        "Indian/Antananarivo",
        "Indian/Chagos",
        "Indian/Christmas",
        "Indian/Cocos",
        "Indian/Comoro",
        "Indian/Kerguelen",
        "Indian/Mahe",
        "Indian/Maldives",
        "Indian/Mauritius",
        "Indian/Mayotte",
        "Indian/Reunion",
        "Iran",
        "Israel",
        "Jamaica",
        "Japan",
        "Kwajalein",
        "Libya",
        "MET",
        "MST",
        "MST7MDT",
        "Mexico/BajaNorte",
        "Mexico/BajaSur",
        "Mexico/General",
        "NZ",
        "NZ-CHAT",
        "Navajo",
        "PRC",
        "PST8PDT",
        "Pacific/Apia",
        "Pacific/Auckland",
        "Pacific/Bougainville",
        "Pacific/Chatham",
        "Pacific/Chuuk",
        "Pacific/Easter",
        "Pacific/Efate",
        "Pacific/Enderbury",
        "Pacific/Fakaofo",
        "Pacific/Fiji",
        "Pacific/Funafuti",
        "Pacific/Galapagos",
        "Pacific/Gambier",
        "Pacific/Guadalcanal",
        "Pacific/Guam",
        "Pacific/Honolulu",
        "Pacific/Johnston",
        "Pacific/Kanton",
        "Pacific/Kiritimati",
        "Pacific/Kosrae",
        "Pacific/Kwajalein",
        "Pacific/Majuro",
        "Pacific/Marquesas",
        "Pacific/Midway",
        "Pacific/Nauru",
        "Pacific/Niue",
        "Pacific/Norfolk",
        "Pacific/Noumea",
        "Pacific/Pago_Pago",
        "Pacific/Palau",
        "Pacific/Pitcairn",
        "Pacific/Pohnpei",
        "Pacific/Ponape",
        "Pacific/Port_Moresby",
        "Pacific/Rarotonga",
        "Pacific/Saipan",
        "Pacific/Samoa",
        "Pacific/Tahiti",
        "Pacific/Tarawa",
        "Pacific/Tongatapu",
        "Pacific/Truk",
        "Pacific/Wake",
        "Pacific/Wallis",
        "Pacific/Yap",
        "Poland",
        "Portugal",
        "ROC",
        "ROK",
        "Singapore",
        "Turkey",
        "UCT",
        "US/Alaska",
        "US/Aleutian",
        "US/Arizona",
        "US/Central",
        "US/East-Indiana",
        "US/Eastern",
        "US/Hawaii",
        "US/Indiana-Starke",
        "US/Michigan",
        "US/Mountain",
        "US/Pacific",
        "US/Samoa",
        "UTC",
        "Universal",
        "W-SU",
        "WET",
        "Zulu"
      ]
    }
  },
  "required": [
    "PCID",
    "email",
    "name",
    "role"
  ]
}

---

gorgias_admin_create_view

Create a view

Parameters:

Parameter	Type	Required	Default	Description
deactivated_datetime	string	No	—	When the view was deactivated.
decoration	object	No	—	Object describing how the view appears in our applications. Currently only supports emoji field that shows before the view’s name.
fields	string[]	No	—	List of object’s attributes to be displayed in the UI of our applications.
filters	string	No	—	The logic used to filter the items to be displayed in the view (as JavaScript code).
name	string	Yes	—	The name of the view.
order_by	string	No	—	Name of the object’s attribute used to sort the items of the view.
order_dir	string	No	—	Sort direction of the items displayed in the view. Options: asc or desc.
shared_with_teams	integer[]	No	—	Shared With Teams
shared_with_users	integer[]	No	—	Shared With Users
slug	string	No	—	DEPRECATED - URL-compatible name of the view.
type	string	No	—	Type of objects the view is applied on.
visibility	string	No	—	Visibility of the view. Possible values are: - public: any user of your helpdesk can see it. - shared: users listed under shared_with_users attribute and teams listed under shared_with_teams attribute can see it. All admins and lead agents will see it as well, even if they are not explicitly listed in the shared_with_users attribute. - private: only the single user listed under shared_with_users attribute can see it.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deactivated_datetime": {
      "type": "string",
      "description": "When the view was deactivated."
    },
    "decoration": {
      "type": "object",
      "description": "Object describing how the view appears in our applications. Currently only supports `emoji` field that shows before the view's name.",
      "properties": {
        "emoji": {
          "type": "string",
          "description": "Emoji displayed before the view's name."
        }
      }
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "id",
          "details",
          "tags",
          "customer",
          "last_message",
          "name",
          "email",
          "created",
          "updated",
          "assignee",
          "assignee_team",
          "channel",
          "closed",
          "language",
          "last_received_message",
          "integrations",
          "snooze",
          "status",
          "subject",
          "priority"
        ]
      },
      "description": "List of object's attributes to be displayed in the UI of our applications."
    },
    "filters": {
      "type": "string",
      "description": "The logic used to filter the items to be displayed in the view (as JavaScript code)."
    },
    "name": {
      "type": "string",
      "description": "The name of the view."
    },
    "order_by": {
      "type": "string",
      "description": "Name of the object's attribute used to sort the items of the view."
    },
    "order_dir": {
      "type": "string",
      "description": "Sort direction of the items displayed in the view. Options: `asc` or `desc`.",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "shared_with_teams": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Shared With Teams"
    },
    "shared_with_users": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Shared With Users"
    },
    "slug": {
      "type": "string",
      "description": "DEPRECATED - URL-compatible name of the view."
    },
    "type": {
      "type": "string",
      "description": "Type of objects the view is applied on.",
      "enum": [
        "ticket-list"
      ]
    },
    "visibility": {
      "type": "string",
      "description": "Visibility of the view.  Possible values are:  - `public`: any user of your helpdesk can see it. - `shared`: users listed under `shared_with_users` attribute and teams listed under `shared_with_teams` attribute can see it. All admins and lead agents will see it as well, even if they are not explicitly listed in the `shared_with_users` attribute. - `private`: only the single user listed under `shared_with_users` attribute can see it.",
      "enum": [
        "public",
        "shared",
        "private"
      ]
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

---

gorgias_admin_create_widget

Create a widget

Parameters:

Parameter	Type	Required	Default	Description
app_id	string	null	No	—	The ID of the 3rd party app that the widget’s data is attached to. Used for customer external data widgets.
context	string	No	—	The context to display this widget in. Supported values are: ticket, customer, user. The value <span style={{color: ‘red’}}>user has been deprecated</span>, please use customer instead.
deactivated_datetime	string	null	No	—	When the widget was deactivated.
integration_id	integer	null	No	—	ID of the integration that the widget’s data is attached to. Only used for widgets attached to HTTP integrations. Widgets are the same for all Shopify integrations, but each HTTP integration needs a specific widget.
order	integer	No	—	Order of precedence of the widget. Widgets with lower order are shown first.
template	object	Yes	—	Template to render the data of the widget.
type	string	Yes	—	Type of data the widget is attached to.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "app_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The ID of the 3rd party app that  the widget's data is attached to. Used for customer external data widgets."
    },
    "context": {
      "type": "string",
      "description": "The context to display this widget in.  Supported values are: `ticket`, `customer`, `user`.  The value <span style={{color: 'red'}}>`user` has been deprecated</span>,  please use `customer` instead.",
      "enum": [
        "ticket",
        "customer",
        "user"
      ]
    },
    "deactivated_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the widget was deactivated."
    },
    "integration_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "ID of the integration that the widget's data is attached to. Only used for widgets attached to HTTP integrations. Widgets are the same for all Shopify integrations, but each HTTP integration needs a specific widget."
    },
    "order": {
      "type": "integer",
      "description": "Order of precedence of the widget. Widgets with lower order are shown first."
    },
    "template": {
      "type": "object",
      "description": "Template to render the data of the widget."
    },
    "type": {
      "type": "string",
      "description": "Type of data the widget is attached to.",
      "enum": [
        "bigcommerce",
        "custom",
        "customer_external_data",
        "http",
        "magento2",
        "recharge",
        "shopify",
        "smile",
        "standalone",
        "yotpo",
        "klaviyo",
        "stripe",
        "woocommerce"
      ]
    }
  },
  "required": [
    "PCID",
    "template",
    "type"
  ]
}

---

gorgias_admin_delete_integration

Delete an integration

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the integration to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the integration to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_delete_macro

Delete a macro

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the macro to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the macro to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_delete_rule

Delete a rule

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the rule to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the rule to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_delete_team

Delete a team

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the team to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the team to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_delete_user

Delete a user

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the user to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the user to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_delete_view

Delete a view

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the view to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the view to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_delete_widget

Delete a widget

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the widget to delete.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the widget to delete."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_get_account

Retrieve your account

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

gorgias_admin_get_integration

Retrieve an integration

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the integration to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the integration to retrieve."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_get_job

Retrieve a job

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the job to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the job to retrieve."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_get_macro

Retrieve a macro

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the macro to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the macro to retrieve."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_get_rule

Retrieve a rule

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the rule to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the rule to retrieve."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_get_team

Retrieve a team

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the team to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the team to retrieve."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_get_user

Retrieve a user

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the user to retrieve. Use the ID 0 to fetch your user (current user).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the user to retrieve. Use the ID `0` to fetch your user (current user)."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_get_view

Retrieve a view

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the view to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the view to retrieve."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_get_widget

Retrieve a widget

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the widget to retrieve.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the widget to retrieve."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_list_account_settings

List settings

Parameters:

Parameter	Type	Required	Default	Description
type	string	No	—	The type value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "type": {
      "type": "string",
      "description": "The type value"
    }
  },
  "required": [
    "PCID"
  ]
}

---

gorgias_admin_list_integrations

List integrations

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	Value indicating your position in the list of all integrations. If omitted, the first integrations of the list will be returned.
limit	integer	No	—	Maximum number of integrations to return.
order_by	string	No	—	Attribute used to order integrations.
type	string	No	—	Type of integration.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "Value indicating your position in the list of all integrations. If omitted, the first integrations of the list will be returned."
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of integrations to return."
    },
    "order_by": {
      "type": "string",
      "description": "Attribute used to order integrations.",
      "enum": [
        "created_datetime:asc",
        "created_datetime:desc"
      ]
    },
    "type": {
      "type": "string",
      "description": "Type of integration.",
      "enum": [
        "email",
        "gmail",
        "outlook",
        "app",
        "aircall",
        "facebook",
        "gorgias_chat",
        "phone",
        "sms",
        "twitter",
        "yotpo",
        "whatsapp",
        "http",
        "shopify",
        "recharge",
        "smile",
        "smooch_inside",
        "smooch",
        "magento2",
        "zendesk",
        "klaviyo",
        "bigcommerce",
        "alloy",
        "ecom"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

gorgias_admin_list_jobs

List jobs

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	Value indicating your position in the list of all jobs. If omitted, the first jobs of the list will be returned.
limit	integer	No	—	Maximum number of jobs to return.
order_by	string	No	—	Attribute used to order jobs.
status	string	No	—	Filter jobs by status.
type	string	No	—	Filter jobs by job type.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "Value indicating your position in the list of all jobs. If omitted, the first jobs of the list will be returned."
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of jobs to return."
    },
    "order_by": {
      "type": "string",
      "description": "Attribute used to order jobs.",
      "enum": [
        "created_datetime:asc",
        "created_datetime:desc"
      ]
    },
    "status": {
      "type": "string",
      "description": "Filter jobs by status.",
      "enum": [
        "cancel_requested",
        "canceled",
        "done",
        "errored",
        "fatal_errored",
        "pending",
        "running",
        "scheduled"
      ]
    },
    "type": {
      "type": "string",
      "description": "Filter jobs by job type.",
      "enum": [
        "applyMacro",
        "deleteTicket",
        "exportTicket",
        "importMacro",
        "exportMacro",
        "updateTicket",
        "exportTicketDrilldown",
        "exportConvertCampaignSalesDrilldown"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

gorgias_admin_list_macros

List macros

Parameters:

Parameter	Type	Required	Default	Description
tags	string[]	No	—	The tags value
languages	string[]	No	—	The languages value
cursor	string	No	—	Value indicating your position in the list of all tags. If omitted, the first tags of the list will be returned.
limit	integer	No	—	Maximum number of tags to return.
message_id	integer	No	—	Order macros by the most relevant ones to reply to the given message. When specified, order_by must be set to relevance and ticket_id is required.
order_by	string	No	—	Order macros by the given attribute. If relevance is specified, ticket_id parameter is required and macros will be ordered by the most relevant macros to reply to the given ticket. In this case, order_dir parameter will be ignored.<br>Values <span style={{color: ‘red’}}>name, created_datetime, update_datetime, usage, relevance have been deprecated</span>. Use values with :asc or :desc instead.
search	string	No	—	Filter macros containing the given search query.
ticket_id	integer	No	—	Order macros by the most relevant ones to reply to the given ticket. When specified, order_by must be set to relevance.
number_predictions	integer	No	—	Number of relevant macros to return on top of the list.
archived	boolean	No	—	Filter macros that are archived. If True, only archived macros will be returned.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The tags value"
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The languages value"
    },
    "cursor": {
      "type": "string",
      "description": "Value indicating your position in the list of all tags. If omitted, the first tags of the list will be returned."
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of tags to return."
    },
    "message_id": {
      "type": "integer",
      "description": "Order macros by the most relevant ones to reply to the given message. When specified, `order_by` must be set to `relevance` and `ticket_id` is required."
    },
    "order_by": {
      "type": "string",
      "description": "Order macros by the given attribute. If `relevance` is specified, `ticket_id` parameter is required and macros will be ordered by the most relevant macros to reply to the given ticket. In this case, `order_dir` parameter will be ignored.<br>Values <span style={{color: 'red'}}>`name`, `created_datetime`, `update_datetime`, `usage`, `relevance` have been deprecated</span>. Use values with `:asc` or `:desc` instead.",
      "enum": [
        "name",
        "created_datetime",
        "updated_datetime",
        "usage",
        "relevance",
        "language",
        "name:asc",
        "name:desc",
        "created_datetime:asc",
        "created_datetime:desc",
        "updated_datetime:asc",
        "updated_datetime:desc",
        "usage:asc",
        "usage:desc",
        "relevance:asc",
        "relevance:desc",
        "language:asc",
        "language:desc"
      ]
    },
    "search": {
      "type": "string",
      "description": "Filter macros containing the given search query."
    },
    "ticket_id": {
      "type": "integer",
      "description": "Order macros by the most relevant ones to reply to the given ticket. When specified, `order_by` must be set to `relevance`."
    },
    "number_predictions": {
      "type": "integer",
      "description": "Number of relevant macros to return on top of the list."
    },
    "archived": {
      "type": "boolean",
      "description": "Filter macros that are archived. If `True`, only archived macros will be returned."
    }
  },
  "required": [
    "PCID"
  ]
}

---

gorgias_admin_list_rules

List rules

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	Value indicating your position in the list of all rules. If omitted, the first rules of the list will be returned.
limit	integer	No	—	Maximum number of rules to return.
order_by	string	No	—	Attribute used to order rules.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "Value indicating your position in the list of all rules. If omitted, the first rules of the list will be returned."
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of rules to return."
    },
    "order_by": {
      "type": "string",
      "description": "Attribute used to order rules.",
      "enum": [
        "created_datetime:asc",
        "created_datetime:desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

gorgias_admin_list_teams

List teams

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	Value indicating your position in the list of all teams. If omitted, the first team of the list will be returned.
limit	integer	No	—	Maximum number of teams to return.
order_by	string	No	—	Attribute used to order teams.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "Value indicating your position in the list of all teams. If omitted, the first team of the list will be returned."
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of teams to return."
    },
    "order_by": {
      "type": "string",
      "description": "Attribute used to order teams.",
      "enum": [
        "created_datetime:asc",
        "created_datetime:desc",
        "name:asc",
        "name:desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

gorgias_admin_list_users

List users

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	Value indicating your position in the list of all items. If omitted, the first items of the list will be returned.
external_id	string	No	—	ID of the user in a foreign system (Stripe, Aircall, etc…) you’re looking for
email	string	No	—	Email of the user you’re looking for
limit	integer	No	—	Maximum number of items to return.
order_by	string	No	—	Attribute used to order users.
roles	string[]	No	—	A list of roles to filter users.
search	string	No	—	Retrieve users where either the name or email address matches the specified search term.
available_first	boolean	No	—	When true, available users are returned first, followed by non-available users.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "Value indicating your position in the list of all items. If omitted, the first items of the list will be returned."
    },
    "external_id": {
      "type": "string",
      "description": "ID of the user in a foreign system (Stripe, Aircall, etc...) you're looking for"
    },
    "email": {
      "type": "string",
      "description": "Email of the user you're looking for"
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of items to return."
    },
    "order_by": {
      "type": "string",
      "description": "Attribute used to order users.",
      "enum": [
        "created_datetime:asc",
        "created_datetime:desc",
        "name:asc",
        "name:desc",
        "email:asc",
        "email:desc",
        "role.name:asc",
        "role.name:desc"
      ]
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "admin",
          "agent",
          "basic-agent",
          "bot",
          "internal-agent",
          "lite-agent",
          "observer-agent"
        ]
      },
      "description": "A list of roles to filter users."
    },
    "search": {
      "type": "string",
      "description": "Retrieve users where either the name or email address matches the specified search term."
    },
    "available_first": {
      "type": "boolean",
      "description": "When true, available users are returned first, followed by non-available users."
    }
  },
  "required": [
    "PCID"
  ]
}

---

gorgias_admin_list_view_items

List view’s items

Parameters:

Parameter	Type	Required	Default	Description
view_id	integer	Yes	—	The ID of the view to list items from.
cursor	string	No	—	Value indicating your position in the list of all the view’s items. If omitted, the first items of the list will be returned.
direction	string	No	—	- prev returns items before the cursor. - next returns items after the cursor.
ignored_item	integer	No	—	ID of an item to ignore in the list of returned items.
limit	integer	No	—	Maximum number of items to return.
order_by	string	No	—	Attribute used to order views.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "view_id": {
      "type": "integer",
      "description": "The ID of the view to list items from."
    },
    "cursor": {
      "type": "string",
      "description": "Value indicating your position in the list of all the view's items. If omitted, the first items of the list will be returned."
    },
    "direction": {
      "type": "string",
      "description": "- `prev` returns items before the cursor. - `next` returns items after the cursor.",
      "enum": [
        "prev",
        "next"
      ]
    },
    "ignored_item": {
      "type": "integer",
      "description": "ID of an item to ignore in the list of returned items."
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of items to return."
    },
    "order_by": {
      "type": "string",
      "description": "Attribute used to order views.",
      "enum": [
        "created_datetime:asc",
        "created_datetime:desc",
        "updated_datetime:asc",
        "updated_datetime:desc",
        "last_message_datetime:asc",
        "last_message_datetime:desc",
        "last_received_message_datetime:asc",
        "last_received_message_datetime:desc",
        "closed_datetime:asc",
        "closed_datetime:desc",
        "snooze_datetime:asc",
        "snooze_datetime:desc",
        "priority:asc",
        "priority:desc"
      ]
    }
  },
  "required": [
    "PCID",
    "view_id"
  ]
}

---

gorgias_admin_list_views

List views

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	Value indicating your position in the list of all views. If omitted, the first views of the list will be returned.
limit	integer	No	—	Maximum number of views to return.
order_by	string	No	—	Attribute used to order views.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "Value indicating your position in the list of all views. If omitted, the first views of the list will be returned."
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of views to return."
    },
    "order_by": {
      "type": "string",
      "description": "Attribute used to order views.",
      "enum": [
        "created_datetime:asc",
        "created_datetime:desc"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

gorgias_admin_list_widgets

List widgets

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	Value indicating your position in the list of all widgets. If omitted, the first widgets of the list will be returned.
limit	integer	No	—	Maximum number of widgets to return.
order_by	string	No	—	Attribute used to order widgets.
integration_id	integer	No	—	The ID of the integration to filter the widgets list by.
app_id	string	No	—	The ID of the 3rd party app to filter the widgets list by.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "Value indicating your position in the list of all widgets. If omitted, the first widgets of the list will be returned."
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of widgets to return."
    },
    "order_by": {
      "type": "string",
      "description": "Attribute used to order widgets.",
      "enum": [
        "created_datetime:asc",
        "created_datetime:desc",
        "order:asc",
        "order:desc"
      ]
    },
    "integration_id": {
      "type": "integer",
      "description": "The ID of the integration to filter the widgets list by."
    },
    "app_id": {
      "type": "string",
      "description": "The ID of the 3rd party app to filter the widgets list by."
    }
  },
  "required": [
    "PCID"
  ]
}

---

gorgias_admin_update_account_setting

Update a setting

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the setting to update.
data	object	No	—	The data value
type	string	No	—	The type value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the setting to update."
    },
    "data": {
      "description": "The data value"
    },
    "type": {
      "type": "string",
      "description": "The type value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_update_integration

Update an integration

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the integration to update.
deactivated_datetime	string	null	No	—	When the integration was deactivated.
description	string	null	No	—	Description about the integration.
http	object	No	—	Only available for HTTP integrations, defines the configuration of the integration.
name	string	No	—	Name of the integration. Usually the email address, Facebook page name, etc.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the integration to update."
    },
    "deactivated_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the integration was deactivated."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Description about the integration."
    },
    "http": {
      "type": "object",
      "description": "Only available for HTTP integrations, defines the configuration of the integration.",
      "properties": {
        "form": {
          "type": "object",
          "description": "Data to send to the external service. It can either be a raw JSON object (if `request_content_type` is `application/json`) or a key-value object representing form data (if `request_content_type` is `application/x-www-form-urlencoded`). You can use variables like {{ticket.customer.email}} as values for the request. Check all properties from a [customer](#the-customer-object), or review the list of [Gorgias variables](https://docs.gorgias.com/macros/macro-variables#gorgias_variables) for inspiration."
        },
        "headers": {
          "type": "object",
          "description": "HTTP headers expected by the external service."
        },
        "hmac_secret": {
          "type": "string",
          "description": "The HMAC secret to use to sign HTTP calls to the external service."
        },
        "method": {
          "type": "string",
          "description": "HTTP method expected by the external service.",
          "enum": [
            "GET",
            "POST",
            "PUT",
            "DELETE",
            "HEAD",
            "PATCH"
          ]
        },
        "request_content_type": {
          "type": "string",
          "description": "Content type of the outgoing request to the external service.",
          "enum": [
            "application/json",
            "application/x-www-form-urlencoded"
          ]
        },
        "response_content_type": {
          "type": "string",
          "description": "Content type of the incoming response from the external service.",
          "enum": [
            "application/json"
          ]
        },
        "triggers": {
          "type": "object",
          "description": "Events that will trigger the request to the external service."
        },
        "url": {
          "type": "string",
          "description": "URL of the external service. You can use variables like {{ticket.customer.email}} to pass customer data to the integration. Check all properties from a [customer](#the-customer-object), or review the list of [Gorgias variables](https://docs.gorgias.com/macros/macro-variables#gorgias_variables) for inspiration."
        }
      },
      "required": [
        "url"
      ]
    },
    "name": {
      "type": "string",
      "description": "Name of the integration. Usually the email address, Facebook page name, etc."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_update_job

Update a job

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the job to update.
meta	object	No	—	Metadata associated with the job. You can use this parameter to store structured information (key-value data) about the job. This field is not used by Gorgias.
params	object	No	—	The parameters of the job.
scheduled_datetime	string	null	No	—	When the job was scheduled to be started. A job cannot be scheduled more than 60 minutes in the future. If unspecified, the job is queued for execution immediately after creation.
status	string	No	—	The status of the job. Options: cancel_requested, canceled, done, errored, fatal_errored, pending, running, scheduled

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the job to update."
    },
    "meta": {
      "type": "object",
      "description": "Metadata associated with the job. You can use this parameter to store structured information (key-value data) about the job. This field is not used by Gorgias."
    },
    "params": {
      "type": "object",
      "description": "The parameters of the job.",
      "properties": {
        "apply_and_close": {
          "type": "boolean",
          "description": "Whether the ticket should be closed once the macro is applied on it. Only applies to `applyMacro` jobs."
        },
        "context": {
          "type": "object",
          "description": "Object (key-value) containing extra context for the job"
        },
        "end_datetime": {
          "type": "string",
          "description": "End of the interval from which to select tickets when the parameter `view` is used."
        },
        "macro_id": {
          "type": "integer",
          "description": "The ID of the macro to apply on the selected tickets. Only applies to `applyMacro` jobs."
        },
        "start_datetime": {
          "type": "string",
          "description": "Beginning of the interval from which to select tickets when the parameter `view` is used."
        },
        "ticket_ids": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "A list of ticket IDs to be processed by the job."
        },
        "updates": {
          "type": "object",
          "description": "Object (key-value) containing all the changes to apply on the selected tickets. Only applies to `updateTicket` jobs."
        },
        "url": {
          "type": "string",
          "description": "The path to the file to import."
        },
        "view": {
          "type": "object",
          "description": "A [view](#the-view-object)-like object used to select the tickets to be processed by the job."
        },
        "view_id": {
          "type": "integer",
          "description": "The ID of an existing [view](#the-view-object) used to select the tickets to be processed by the job."
        }
      }
    },
    "scheduled_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the job was scheduled to be started. A job cannot be scheduled more than 60 minutes in the future. If unspecified, the job is queued for execution immediately after creation."
    },
    "status": {
      "type": "string",
      "description": "The status of the job. Options: cancel_requested, canceled, done, errored, fatal_errored, pending, running, scheduled",
      "enum": [
        "cancel_requested",
        "canceled",
        "done",
        "errored",
        "fatal_errored",
        "pending",
        "running",
        "scheduled"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_update_macro

Update a macro

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the macro to update.
actions	object[]	No	—	A list of actions to be applied on tickets.
external_id	string	null	No	—	External ID of the macro in a foreign system. This field is not used by Gorgias, feel free to set it to your own value.
intent	string	null	No	—	The intention of the macro should be used for.
language	string	null	No	—	The language of the macro in ISO 639-1 format.
name	string	No	—	The name of the Macro. Tips: choose a name that can be easily searched.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the macro to update."
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "arguments": {
            "type": "object",
            "description": "Parameters of the action. These parameters vary according to the name of the action."
          },
          "description": {
            "type": "string",
            "description": "Description of what the action does."
          },
          "name": {
            "type": "string",
            "description": "The name of the action."
          },
          "title": {
            "type": "string",
            "description": "The title of the action."
          },
          "type": {
            "type": "string",
            "enum": [
              "system",
              "user"
            ],
            "description": "The type of action."
          }
        },
        "required": [
          "arguments",
          "name",
          "title"
        ]
      },
      "description": "A list of [actions](#the-macroaction-object) to be applied on tickets."
    },
    "external_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "External ID of the macro in a foreign system. This field is not used by Gorgias, feel free to set it to your own value."
    },
    "intent": {
      "type": [
        "string",
        "null"
      ],
      "description": "The intention of the macro should be used for.",
      "enum": [
        "discount/request",
        "exchange/request",
        "exchange/status",
        "feedback",
        "order/damaged",
        "order/cancel",
        "order/change",
        "order/wrong",
        "other/no_reply",
        "other/question",
        "other/thanks",
        "product/recommendation",
        "product/question",
        "refund/request",
        "refund/status",
        "return/request",
        "return/status",
        "shipping/change",
        "shipping/delivery-issue",
        "shipping/policy",
        "shipping/status",
        "stock/request",
        "subscription/cancel",
        "subscription/change"
      ]
    },
    "language": {
      "type": [
        "string",
        "null"
      ],
      "description": "The language of the macro in ISO 639-1 format."
    },
    "name": {
      "type": "string",
      "description": "The name of the Macro. Tips: choose a name that can be easily searched."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_update_rule

Update a rule

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the rule to update.
code	string	No	—	The logic of the rule (as JavaScript code).
code_ast	object	No	—	The logic of the rule (as an ESTree AST representation). Generated from the code if not specified.
deactivated_datetime	string	null	No	—	When the rule was deactivated.
description	string	null	No	—	The description of the rule.
event_types	string	No	—	A list of comma separated events that this rule will be executed on. Valid values: ticket-created, ticket-updated, ticket-message-created, ticket-assigned, ticket-self-unsnoozed, satisfaction-survey-responded.
name	string	No	—	The name of the rule.
priority	integer	No	—	Order of execution of the rule. Rules with higher priorities are executed first.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the rule to update."
    },
    "code": {
      "type": "string",
      "description": "The logic of the rule (as JavaScript code)."
    },
    "code_ast": {
      "type": "object",
      "description": "The logic of the rule (as an ESTree [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) representation). Generated from the code if not specified."
    },
    "deactivated_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the rule was deactivated."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The description of the rule."
    },
    "event_types": {
      "type": "string",
      "description": "A list of comma separated events that this rule will be executed on. Valid values: ticket-created, ticket-updated, ticket-message-created, ticket-assigned, ticket-self-unsnoozed, satisfaction-survey-responded."
    },
    "name": {
      "type": "string",
      "description": "The name of the rule."
    },
    "priority": {
      "type": "integer",
      "description": "Order of execution of the rule. Rules with higher priorities are executed first."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_update_rules_priorities

Update rules’ priorities

Parameters:

Parameter	Type	Required	Default	Description
priorities	object[]	Yes	—	A list of rule IDs with their new priorities.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "priorities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "ID of the rule."
          },
          "priority": {
            "type": "integer",
            "description": "Order of execution of the rule. Rules with higher priorities are executed first."
          }
        },
        "required": [
          "id",
          "priority"
        ]
      },
      "description": "A list of rule IDs with their new priorities."
    }
  },
  "required": [
    "PCID",
    "priorities"
  ]
}

---

gorgias_admin_update_team

Update a team

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the team to update.
decoration	object	No	—	Object describing how the team appears on the webpage. Currently only supports emoji field that shows before the team’s name.
description	string	null	No	—	Longer description of the team.
members	object[]	No	—	The list of users within the team.
name	string	No	—	Name of the team.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the team to update."
    },
    "decoration": {
      "type": "object",
      "description": "Object describing how the team appears on the webpage. Currently only supports `emoji` field that shows before the team's name."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Longer description of the team."
    },
    "members": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "description": "The email address of the user"
          },
          "id": {
            "type": "integer",
            "description": "ID of the object"
          },
          "meta": {
            "type": "object",
            "description": "User defined JSON field. It can be useful for storing additional info about the object."
          },
          "name": {
            "type": "string",
            "description": "The full name of the user"
          }
        }
      },
      "description": "The list of users within the team."
    },
    "name": {
      "type": "string",
      "description": "Name of the team."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_update_user

Update a user

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the user to update. Use the ID 0 to update your user (current user).
bio	string	null	No	—	Short biography of the user.
country	string	null	No	—	Country of the user
email	string	No	—	Email address of the user. password_confirmation field must be provided to change the email.
external_id	string	No	—	ID of the user in a foreign system (Stripe, Aircall, etc…). This field is not used by Gorgias, feel free to set it as you wish.
language	string	null	No	—	Language of the user.
meta	object	No	—	Data associated with the user. You can use this field to store structured information (key-value data) about the user.
name	string	No	—	Full name of the user.
new_password	string	No	—	New password of the user. old_password field must be provided when changing the password.
old_password	string	No	—	Current password of the user.
password_confirmation	string	No	—	Current password of the user.
role	object	No	—	The role of the user.
timezone	string	No	—	Timezone of the user.
two_fa_code	string	null	No	—	Two Fa Code

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the user to update. Use the ID `0` to update your user (current user)."
    },
    "bio": {
      "type": [
        "string",
        "null"
      ],
      "description": "Short biography of the user."
    },
    "country": {
      "type": [
        "string",
        "null"
      ],
      "description": "Country of the user"
    },
    "email": {
      "type": "string",
      "description": "Email address of the user. `password_confirmation` field must be provided to change the email."
    },
    "external_id": {
      "type": "string",
      "description": "ID of the user in a foreign system (Stripe, Aircall, etc...). This field is not used by Gorgias, feel free to set it as you wish."
    },
    "language": {
      "type": [
        "string",
        "null"
      ],
      "description": "Language of the user.",
      "enum": [
        "fr",
        "en"
      ]
    },
    "meta": {
      "type": "object",
      "description": "Data associated with the user. You can use this field to store structured information (key-value data) about the user.",
      "properties": {
        "profile_picture_url": {
          "type": "string",
          "description": "URL of the profile picture of the user"
        },
        "sso": {
          "type": "string",
          "description": "Name of the Single Sign-On provider the user can use to log in",
          "enum": [
            "google",
            "office365"
          ]
        }
      }
    },
    "name": {
      "type": "string",
      "description": "Full name of the user."
    },
    "new_password": {
      "type": "string",
      "description": "New password of the user. `old_password` field must be provided when changing the password."
    },
    "old_password": {
      "type": "string",
      "description": "Current password of the user."
    },
    "password_confirmation": {
      "type": "string",
      "description": "Current password of the user."
    },
    "role": {
      "type": "object",
      "description": "The role of the user.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the role",
          "enum": [
            "admin",
            "agent",
            "basic-agent",
            "lite-agent",
            "observer-agent"
          ]
        }
      },
      "required": [
        "name"
      ]
    },
    "timezone": {
      "type": "string",
      "description": "Timezone of the user.",
      "enum": [
        "Africa/Abidjan",
        "Africa/Accra",
        "Africa/Addis_Ababa",
        "Africa/Algiers",
        "Africa/Asmara",
        "Africa/Asmera",
        "Africa/Bamako",
        "Africa/Bangui",
        "Africa/Banjul",
        "Africa/Bissau",
        "Africa/Blantyre",
        "Africa/Brazzaville",
        "Africa/Bujumbura",
        "Africa/Cairo",
        "Africa/Casablanca",
        "Africa/Ceuta",
        "Africa/Conakry",
        "Africa/Dakar",
        "Africa/Dar_es_Salaam",
        "Africa/Djibouti",
        "Africa/Douala",
        "Africa/El_Aaiun",
        "Africa/Freetown",
        "Africa/Gaborone",
        "Africa/Harare",
        "Africa/Johannesburg",
        "Africa/Juba",
        "Africa/Kampala",
        "Africa/Khartoum",
        "Africa/Kigali",
        "Africa/Kinshasa",
        "Africa/Lagos",
        "Africa/Libreville",
        "Africa/Lome",
        "Africa/Luanda",
        "Africa/Lubumbashi",
        "Africa/Lusaka",
        "Africa/Malabo",
        "Africa/Maputo",
        "Africa/Maseru",
        "Africa/Mbabane",
        "Africa/Mogadishu",
        "Africa/Monrovia",
        "Africa/Nairobi",
        "Africa/Ndjamena",
        "Africa/Niamey",
        "Africa/Nouakchott",
        "Africa/Ouagadougou",
        "Africa/Porto-Novo",
        "Africa/Sao_Tome",
        "Africa/Timbuktu",
        "Africa/Tripoli",
        "Africa/Tunis",
        "Africa/Windhoek",
        "America/Adak",
        "America/Anchorage",
        "America/Anguilla",
        "America/Antigua",
        "America/Araguaina",
        "America/Argentina/Buenos_Aires",
        "America/Argentina/Catamarca",
        "America/Argentina/ComodRivadavia",
        "America/Argentina/Cordoba",
        "America/Argentina/Jujuy",
        "America/Argentina/La_Rioja",
        "America/Argentina/Mendoza",
        "America/Argentina/Rio_Gallegos",
        "America/Argentina/Salta",
        "America/Argentina/San_Juan",
        "America/Argentina/San_Luis",
        "America/Argentina/Tucuman",
        "America/Argentina/Ushuaia",
        "America/Aruba",
        "America/Asuncion",
        "America/Atikokan",
        "America/Atka",
        "America/Bahia",
        "America/Bahia_Banderas",
        "America/Barbados",
        "America/Belem",
        "America/Belize",
        "America/Blanc-Sablon",
        "America/Boa_Vista",
        "America/Bogota",
        "America/Boise",
        "America/Buenos_Aires",
        "America/Cambridge_Bay",
        "America/Campo_Grande",
        "America/Cancun",
        "America/Caracas",
        "America/Catamarca",
        "America/Cayenne",
        "America/Cayman",
        "America/Chicago",
        "America/Chihuahua",
        "America/Coral_Harbour",
        "America/Cordoba",
        "America/Costa_Rica",
        "America/Creston",
        "America/Cuiaba",
        "America/Curacao",
        "America/Danmarkshavn",
        "America/Dawson",
        "America/Dawson_Creek",
        "America/Denver",
        "America/Detroit",
        "America/Dominica",
        "America/Edmonton",
        "America/Eirunepe",
        "America/El_Salvador",
        "America/Ensenada",
        "America/Fort_Nelson",
        "America/Fort_Wayne",
        "America/Fortaleza",
        "America/Glace_Bay",
        "America/Godthab",
        "America/Goose_Bay",
        "America/Grand_Turk",
        "America/Grenada",
        "America/Guadeloupe",
        "America/Guatemala",
        "America/Guayaquil",
        "America/Guyana",
        "America/Halifax",
        "America/Havana",
        "America/Hermosillo",
        "America/Indiana/Indianapolis",
        "America/Indiana/Knox",
        "America/Indiana/Marengo",
        "America/Indiana/Petersburg",
        "America/Indiana/Tell_City",
        "America/Indiana/Vevay",
        "America/Indiana/Vincennes",
        "America/Indiana/Winamac",
        "America/Indianapolis",
        "America/Inuvik",
        "America/Iqaluit",
        "America/Jamaica",
        "America/Jujuy",
        "America/Juneau",
        "America/Kentucky/Louisville",
        "America/Kentucky/Monticello",
        "America/Knox_IN",
        "America/Kralendijk",
        "America/La_Paz",
        "America/Lima",
        "America/Los_Angeles",
        "America/Louisville",
        "America/Lower_Princes",
        "America/Maceio",
        "America/Managua",
        "America/Manaus",
        "America/Marigot",
        "America/Martinique",
        "America/Matamoros",
        "America/Mazatlan",
        "America/Mendoza",
        "America/Menominee",
        "America/Merida",
        "America/Metlakatla",
        "America/Mexico_City",
        "America/Miquelon",
        "America/Moncton",
        "America/Monterrey",
        "America/Montevideo",
        "America/Montreal",
        "America/Montserrat",
        "America/Nassau",
        "America/New_York",
        "America/Nipigon",
        "America/Nome",
        "America/Noronha",
        "America/North_Dakota/Beulah",
        "America/North_Dakota/Center",
        "America/North_Dakota/New_Salem",
        "America/Nuuk",
        "America/Ojinaga",
        "America/Panama",
        "America/Pangnirtung",
        "America/Paramaribo",
        "America/Phoenix",
        "America/Port-au-Prince",
        "America/Port_of_Spain",
        "America/Porto_Acre",
        "America/Porto_Velho",
        "America/Puerto_Rico",
        "America/Punta_Arenas",
        "America/Rainy_River",
        "America/Rankin_Inlet",
        "America/Recife",
        "America/Regina",
        "America/Resolute",
        "America/Rio_Branco",
        "America/Rosario",
        "America/Santa_Isabel",
        "America/Santarem",
        "America/Santiago",
        "America/Santo_Domingo",
        "America/Sao_Paulo",
        "America/Scoresbysund",
        "America/Shiprock",
        "America/Sitka",
        "America/St_Barthelemy",
        "America/St_Johns",
        "America/St_Kitts",
        "America/St_Lucia",
        "America/St_Thomas",
        "America/St_Vincent",
        "America/Swift_Current",
        "America/Tegucigalpa",
        "America/Thule",
        "America/Thunder_Bay",
        "America/Tijuana",
        "America/Toronto",
        "America/Tortola",
        "America/Vancouver",
        "America/Virgin",
        "America/Whitehorse",
        "America/Winnipeg",
        "America/Yakutat",
        "America/Yellowknife",
        "Antarctica/Casey",
        "Antarctica/Davis",
        "Antarctica/DumontDUrville",
        "Antarctica/Macquarie",
        "Antarctica/Mawson",
        "Antarctica/McMurdo",
        "Antarctica/Palmer",
        "Antarctica/Rothera",
        "Antarctica/South_Pole",
        "Antarctica/Syowa",
        "Antarctica/Troll",
        "Antarctica/Vostok",
        "Arctic/Longyearbyen",
        "Asia/Aden",
        "Asia/Almaty",
        "Asia/Amman",
        "Asia/Anadyr",
        "Asia/Aqtau",
        "Asia/Aqtobe",
        "Asia/Ashgabat",
        "Asia/Ashkhabad",
        "Asia/Atyrau",
        "Asia/Baghdad",
        "Asia/Bahrain",
        "Asia/Baku",
        "Asia/Bangkok",
        "Asia/Barnaul",
        "Asia/Beirut",
        "Asia/Bishkek",
        "Asia/Brunei",
        "Asia/Calcutta",
        "Asia/Chita",
        "Asia/Choibalsan",
        "Asia/Chongqing",
        "Asia/Chungking",
        "Asia/Colombo",
        "Asia/Dacca",
        "Asia/Damascus",
        "Asia/Dhaka",
        "Asia/Dili",
        "Asia/Dubai",
        "Asia/Dushanbe",
        "Asia/Famagusta",
        "Asia/Gaza",
        "Asia/Harbin",
        "Asia/Hebron",
        "Asia/Ho_Chi_Minh",
        "Asia/Hong_Kong",
        "Asia/Hovd",
        "Asia/Irkutsk",
        "Asia/Istanbul",
        "Asia/Jakarta",
        "Asia/Jayapura",
        "Asia/Jerusalem",
        "Asia/Kabul",
        "Asia/Kamchatka",
        "Asia/Karachi",
        "Asia/Kashgar",
        "Asia/Kathmandu",
        "Asia/Katmandu",
        "Asia/Khandyga",
        "Asia/Kolkata",
        "Asia/Krasnoyarsk",
        "Asia/Kuala_Lumpur",
        "Asia/Kuching",
        "Asia/Kuwait",
        "Asia/Macao",
        "Asia/Macau",
        "Asia/Magadan",
        "Asia/Makassar",
        "Asia/Manila",
        "Asia/Muscat",
        "Asia/Nicosia",
        "Asia/Novokuznetsk",
        "Asia/Novosibirsk",
        "Asia/Omsk",
        "Asia/Oral",
        "Asia/Phnom_Penh",
        "Asia/Pontianak",
        "Asia/Pyongyang",
        "Asia/Qatar",
        "Asia/Qostanay",
        "Asia/Qyzylorda",
        "Asia/Rangoon",
        "Asia/Riyadh",
        "Asia/Saigon",
        "Asia/Sakhalin",
        "Asia/Samarkand",
        "Asia/Seoul",
        "Asia/Shanghai",
        "Asia/Singapore",
        "Asia/Srednekolymsk",
        "Asia/Taipei",
        "Asia/Tashkent",
        "Asia/Tbilisi",
        "Asia/Tehran",
        "Asia/Tel_Aviv",
        "Asia/Thimbu",
        "Asia/Thimphu",
        "Asia/Tokyo",
        "Asia/Tomsk",
        "Asia/Ujung_Pandang",
        "Asia/Ulaanbaatar",
        "Asia/Ulan_Bator",
        "Asia/Urumqi",
        "Asia/Ust-Nera",
        "Asia/Vientiane",
        "Asia/Vladivostok",
        "Asia/Yakutsk",
        "Asia/Yangon",
        "Asia/Yekaterinburg",
        "Asia/Yerevan",
        "Atlantic/Azores",
        "Atlantic/Bermuda",
        "Atlantic/Canary",
        "Atlantic/Cape_Verde",
        "Atlantic/Faeroe",
        "Atlantic/Faroe",
        "Atlantic/Jan_Mayen",
        "Atlantic/Madeira",
        "Atlantic/Reykjavik",
        "Atlantic/South_Georgia",
        "Atlantic/St_Helena",
        "Atlantic/Stanley",
        "Australia/ACT",
        "Australia/Adelaide",
        "Australia/Brisbane",
        "Australia/Broken_Hill",
        "Australia/Canberra",
        "Australia/Currie",
        "Australia/Darwin",
        "Australia/Eucla",
        "Australia/Hobart",
        "Australia/LHI",
        "Australia/Lindeman",
        "Australia/Lord_Howe",
        "Australia/Melbourne",
        "Australia/NSW",
        "Australia/North",
        "Australia/Perth",
        "Australia/Queensland",
        "Australia/South",
        "Australia/Sydney",
        "Australia/Tasmania",
        "Australia/Victoria",
        "Australia/West",
        "Australia/Yancowinna",
        "Brazil/Acre",
        "Brazil/DeNoronha",
        "Brazil/East",
        "Brazil/West",
        "CET",
        "CST6CDT",
        "Canada/Atlantic",
        "Canada/Central",
        "Canada/Eastern",
        "Canada/Mountain",
        "Canada/Newfoundland",
        "Canada/Pacific",
        "Canada/Saskatchewan",
        "Canada/Yukon",
        "Chile/Continental",
        "Chile/EasterIsland",
        "Cuba",
        "EET",
        "EST",
        "EST5EDT",
        "Egypt",
        "Eire",
        "Etc/GMT",
        "Etc/GMT+0",
        "Etc/GMT+1",
        "Etc/GMT+10",
        "Etc/GMT+11",
        "Etc/GMT+12",
        "Etc/GMT+2",
        "Etc/GMT+3",
        "Etc/GMT+4",
        "Etc/GMT+5",
        "Etc/GMT+6",
        "Etc/GMT+7",
        "Etc/GMT+8",
        "Etc/GMT+9",
        "Etc/GMT-0",
        "Etc/GMT-1",
        "Etc/GMT-10",
        "Etc/GMT-11",
        "Etc/GMT-12",
        "Etc/GMT-13",
        "Etc/GMT-14",
        "Etc/GMT-2",
        "Etc/GMT-3",
        "Etc/GMT-4",
        "Etc/GMT-5",
        "Etc/GMT-6",
        "Etc/GMT-7",
        "Etc/GMT-8",
        "Etc/GMT-9",
        "Etc/GMT0",
        "Etc/Greenwich",
        "Etc/UCT",
        "Etc/UTC",
        "Etc/Universal",
        "Etc/Zulu",
        "Europe/Amsterdam",
        "Europe/Andorra",
        "Europe/Astrakhan",
        "Europe/Athens",
        "Europe/Belfast",
        "Europe/Belgrade",
        "Europe/Berlin",
        "Europe/Bratislava",
        "Europe/Brussels",
        "Europe/Bucharest",
        "Europe/Budapest",
        "Europe/Busingen",
        "Europe/Chisinau",
        "Europe/Copenhagen",
        "Europe/Dublin",
        "Europe/Gibraltar",
        "Europe/Guernsey",
        "Europe/Helsinki",
        "Europe/Isle_of_Man",
        "Europe/Istanbul",
        "Europe/Jersey",
        "Europe/Kaliningrad",
        "Europe/Kiev",
        "Europe/Kirov",
        "Europe/Kyiv",
        "Europe/Lisbon",
        "Europe/Ljubljana",
        "Europe/London",
        "Europe/Luxembourg",
        "Europe/Madrid",
        "Europe/Malta",
        "Europe/Mariehamn",
        "Europe/Minsk",
        "Europe/Monaco",
        "Europe/Moscow",
        "Europe/Nicosia",
        "Europe/Oslo",
        "Europe/Paris",
        "Europe/Podgorica",
        "Europe/Prague",
        "Europe/Riga",
        "Europe/Rome",
        "Europe/Samara",
        "Europe/San_Marino",
        "Europe/Sarajevo",
        "Europe/Saratov",
        "Europe/Simferopol",
        "Europe/Skopje",
        "Europe/Sofia",
        "Europe/Stockholm",
        "Europe/Tallinn",
        "Europe/Tirane",
        "Europe/Tiraspol",
        "Europe/Ulyanovsk",
        "Europe/Uzhgorod",
        "Europe/Vaduz",
        "Europe/Vatican",
        "Europe/Vienna",
        "Europe/Vilnius",
        "Europe/Volgograd",
        "Europe/Warsaw",
        "Europe/Zagreb",
        "Europe/Zaporozhye",
        "Europe/Zurich",
        "GB",
        "GB-Eire",
        "GMT",
        "GMT+0",
        "GMT-0",
        "GMT0",
        "Greenwich",
        "HST",
        "Hongkong",
        "Iceland",
        "Indian/Antananarivo",
        "Indian/Chagos",
        "Indian/Christmas",
        "Indian/Cocos",
        "Indian/Comoro",
        "Indian/Kerguelen",
        "Indian/Mahe",
        "Indian/Maldives",
        "Indian/Mauritius",
        "Indian/Mayotte",
        "Indian/Reunion",
        "Iran",
        "Israel",
        "Jamaica",
        "Japan",
        "Kwajalein",
        "Libya",
        "MET",
        "MST",
        "MST7MDT",
        "Mexico/BajaNorte",
        "Mexico/BajaSur",
        "Mexico/General",
        "NZ",
        "NZ-CHAT",
        "Navajo",
        "PRC",
        "PST8PDT",
        "Pacific/Apia",
        "Pacific/Auckland",
        "Pacific/Bougainville",
        "Pacific/Chatham",
        "Pacific/Chuuk",
        "Pacific/Easter",
        "Pacific/Efate",
        "Pacific/Enderbury",
        "Pacific/Fakaofo",
        "Pacific/Fiji",
        "Pacific/Funafuti",
        "Pacific/Galapagos",
        "Pacific/Gambier",
        "Pacific/Guadalcanal",
        "Pacific/Guam",
        "Pacific/Honolulu",
        "Pacific/Johnston",
        "Pacific/Kanton",
        "Pacific/Kiritimati",
        "Pacific/Kosrae",
        "Pacific/Kwajalein",
        "Pacific/Majuro",
        "Pacific/Marquesas",
        "Pacific/Midway",
        "Pacific/Nauru",
        "Pacific/Niue",
        "Pacific/Norfolk",
        "Pacific/Noumea",
        "Pacific/Pago_Pago",
        "Pacific/Palau",
        "Pacific/Pitcairn",
        "Pacific/Pohnpei",
        "Pacific/Ponape",
        "Pacific/Port_Moresby",
        "Pacific/Rarotonga",
        "Pacific/Saipan",
        "Pacific/Samoa",
        "Pacific/Tahiti",
        "Pacific/Tarawa",
        "Pacific/Tongatapu",
        "Pacific/Truk",
        "Pacific/Wake",
        "Pacific/Wallis",
        "Pacific/Yap",
        "Poland",
        "Portugal",
        "ROC",
        "ROK",
        "Singapore",
        "Turkey",
        "UCT",
        "US/Alaska",
        "US/Aleutian",
        "US/Arizona",
        "US/Central",
        "US/East-Indiana",
        "US/Eastern",
        "US/Hawaii",
        "US/Indiana-Starke",
        "US/Michigan",
        "US/Mountain",
        "US/Pacific",
        "US/Samoa",
        "UTC",
        "Universal",
        "W-SU",
        "WET",
        "Zulu"
      ]
    },
    "two_fa_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "Two Fa Code"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_update_view

Update a view

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the view to update.
deactivated_datetime	string	No	—	When the view was deactivated.
decoration	object	No	—	Object describing how the view appears in our applications. Currently only supports emoji field that shows before the view’s name.
fields	string[]	No	—	List of object’s attributes to be displayed in the UI of our applications.
filters	string	No	—	The logic used to filter the items to be displayed in the view (as JavaScript code).
name	string	No	—	The name of the view.
order_by	string	No	—	Name of the object’s attribute used to sort the items of the view.
order_dir	string	No	—	Sort direction of the items displayed in the view. Options: asc or desc.
shared_with_teams	integer[]	No	—	Shared With Teams
shared_with_users	integer[]	No	—	Shared With Users
slug	string	No	—	DEPRECATED - URL-compatible name of the view.
type	string	No	—	Type of objects the view is applied on.
visibility	string	No	—	Visibility of the view. Possible values are: - public: any user of your helpdesk can see it. - shared: users listed under shared_with_users attribute and teams listed under shared_with_teams attribute can see it. All admins and lead agents will see it as well, even if they are not explicitly listed in the shared_with_users attribute. - private: only the single user listed under shared_with_users attribute can see it.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the view to update."
    },
    "deactivated_datetime": {
      "type": "string",
      "description": "When the view was deactivated."
    },
    "decoration": {
      "type": "object",
      "description": "Object describing how the view appears in our applications. Currently only supports `emoji` field that shows before the view's name.",
      "properties": {
        "emoji": {
          "type": "string",
          "description": "Emoji displayed before the view's name."
        }
      }
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "id",
          "details",
          "tags",
          "customer",
          "last_message",
          "name",
          "email",
          "created",
          "updated",
          "assignee",
          "assignee_team",
          "channel",
          "closed",
          "language",
          "last_received_message",
          "integrations",
          "snooze",
          "status",
          "subject",
          "priority"
        ]
      },
      "description": "List of object's attributes to be displayed in the UI of our applications."
    },
    "filters": {
      "type": "string",
      "description": "The logic used to filter the items to be displayed in the view (as JavaScript code)."
    },
    "name": {
      "type": "string",
      "description": "The name of the view."
    },
    "order_by": {
      "type": "string",
      "description": "Name of the object's attribute used to sort the items of the view."
    },
    "order_dir": {
      "type": "string",
      "description": "Sort direction of the items displayed in the view. Options: `asc` or `desc`.",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "shared_with_teams": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Shared With Teams"
    },
    "shared_with_users": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Shared With Users"
    },
    "slug": {
      "type": "string",
      "description": "DEPRECATED - URL-compatible name of the view."
    },
    "type": {
      "type": "string",
      "description": "Type of objects the view is applied on.",
      "enum": [
        "ticket-list"
      ]
    },
    "visibility": {
      "type": "string",
      "description": "Visibility of the view.  Possible values are:  - `public`: any user of your helpdesk can see it. - `shared`: users listed under `shared_with_users` attribute and teams listed under `shared_with_teams` attribute can see it. All admins and lead agents will see it as well, even if they are not explicitly listed in the `shared_with_users` attribute. - `private`: only the single user listed under `shared_with_users` attribute can see it.",
      "enum": [
        "public",
        "shared",
        "private"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

gorgias_admin_update_view_items

Search for view’s items

Parameters:

Parameter	Type	Required	Default	Description
view_id	integer	Yes	—	This parameter should be set to 0.
cursor	string	No	—	Value indicating your position in the list of all the view’s items. If omitted, the first items of the list will be returned.
direction	string	No	—	- prev returns items before the cursor. - next returns items after the cursor.
ignored_item	integer	No	—	ID of an item to ignore in the list of returned items.
limit	integer	No	—	Maximum number of items to return.
order_by	string	No	—	Attribute used to order views.
view	object	No	—	The view value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "view_id": {
      "type": "integer",
      "description": "This parameter should be set to 0."
    },
    "cursor": {
      "type": "string",
      "description": "Value indicating your position in the list of all the view's items. If omitted, the first items of the list will be returned."
    },
    "direction": {
      "type": "string",
      "description": "- `prev` returns items before the cursor. - `next` returns items after the cursor.",
      "enum": [
        "prev",
        "next"
      ]
    },
    "ignored_item": {
      "type": "integer",
      "description": "ID of an item to ignore in the list of returned items."
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of items to return."
    },
    "order_by": {
      "type": "string",
      "description": "Attribute used to order views.",
      "enum": [
        "created_datetime:asc",
        "created_datetime:desc",
        "updated_datetime:asc",
        "updated_datetime:desc",
        "last_message_datetime:asc",
        "last_message_datetime:desc",
        "last_received_message_datetime:asc",
        "last_received_message_datetime:desc",
        "closed_datetime:asc",
        "closed_datetime:desc",
        "snooze_datetime:asc",
        "snooze_datetime:desc",
        "priority:asc",
        "priority:desc"
      ]
    },
    "view": {
      "type": "object",
      "description": "The view value",
      "properties": {
        "category": {
          "type": "string",
          "description": "Category is an internal, read-only field used to identify system and user views.Example of system views: Trash or Spam. System views cannot be deleted."
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "id",
              "details",
              "tags",
              "customer",
              "last_message",
              "name",
              "email",
              "created",
              "updated",
              "assignee",
              "assignee_team",
              "channel",
              "closed",
              "language",
              "last_received_message",
              "integrations",
              "snooze",
              "status",
              "subject",
              "priority"
            ]
          },
          "description": "List of object's attributes to be displayed in the UI of our applications."
        },
        "filters": {
          "type": "string",
          "description": "The logic used to filter the items to be displayed in the view (as JavaScript code)."
        },
        "order_by": {
          "type": "string",
          "description": "Name of the object's attribute used to sort the items of the view."
        },
        "order_dir": {
          "type": "string",
          "description": "Sort direction of the items displayed in the view. Options: `asc` or `desc`.",
          "enum": [
            "asc",
            "desc"
          ]
        },
        "search": {
          "type": "string",
          "description": "Text used to search for items matching the query."
        },
        "type": {
          "type": "string",
          "description": "Type of objects the view is applied on.",
          "enum": [
            "ticket-list"
          ]
        }
      }
    }
  },
  "required": [
    "PCID",
    "view_id"
  ]
}

---

gorgias_admin_update_widget

Update a widget

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the widget to update.
app_id	string	null	No	—	The ID of the 3rd party app that the widget’s data is attached to. Used for customer external data widgets.
context	string	No	—	The context to display this widget in. Supported values are: ticket, customer, user. The value <span style={{color: ‘red’}}>user has been deprecated</span>, please use customer instead.
deactivated_datetime	string	null	No	—	When the widget was deactivated.
integration_id	integer	null	No	—	ID of the integration that the widget’s data is attached to. Only used for widgets attached to HTTP integrations. Widgets are the same for all Shopify integrations, but each HTTP integration needs a specific widget.
order	integer	No	—	Order of precedence of the widget. Widgets with lower order are shown first.
template	object	No	—	Template to render the data of the widget.
type	string	No	—	Type of data the widget is attached to.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the widget to update."
    },
    "app_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The ID of the 3rd party app that  the widget's data is attached to. Used for customer external data widgets."
    },
    "context": {
      "type": "string",
      "description": "The context to display this widget in.  Supported values are: `ticket`, `customer`, `user`.  The value <span style={{color: 'red'}}>`user` has been deprecated</span>,  please use `customer` instead.",
      "enum": [
        "ticket",
        "customer",
        "user"
      ]
    },
    "deactivated_datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "When the widget was deactivated."
    },
    "integration_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "ID of the integration that the widget's data is attached to. Only used for widgets attached to HTTP integrations. Widgets are the same for all Shopify integrations, but each HTTP integration needs a specific widget."
    },
    "order": {
      "type": "integer",
      "description": "Order of precedence of the widget. Widgets with lower order are shown first."
    },
    "template": {
      "type": "object",
      "description": "Template to render the data of the widget."
    },
    "type": {
      "type": "string",
      "description": "Type of data the widget is attached to.",
      "enum": [
        "bigcommerce",
        "custom",
        "customer_external_data",
        "http",
        "magento2",
        "recharge",
        "shopify",
        "smile",
        "standalone",
        "yotpo",
        "klaviyo",
        "stripe",
        "woocommerce"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}