> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# gorgias-customers
> Gorgias Customers - manage customers, custom fields, events, search, and files
**Server path:** `/gorgias-customers` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| [`gorgias_customers_create_custom_field`](#gorgias_customers_create_custom_field) | Create a custom field |
| [`gorgias_customers_create_customer`](#gorgias_customers_create_customer) | Create a customer |
| [`gorgias_customers_delete_customer`](#gorgias_customers_delete_customer) | Delete a customer |
| [`gorgias_customers_delete_customer_custom_field_value`](#gorgias_customers_delete_customer_custom_field_value) | Delete customer field value |
| [`gorgias_customers_delete_customers`](#gorgias_customers_delete_customers) | Delete customers |
| [`gorgias_customers_download_file`](#gorgias_customers_download_file) | Download a file |
| [`gorgias_customers_get_custom_field`](#gorgias_customers_get_custom_field) | Retrieve a custom field |
| [`gorgias_customers_get_customer`](#gorgias_customers_get_customer) | Retrieve a customer |
| [`gorgias_customers_get_event`](#gorgias_customers_get_event) | Retrieve an event |
| [`gorgias_customers_list_custom_fields`](#gorgias_customers_list_custom_fields) | List custom fields |
| [`gorgias_customers_list_customer_custom_fields_values`](#gorgias_customers_list_customer_custom_fields_values) | List customer field values |
| [`gorgias_customers_list_customers`](#gorgias_customers_list_customers) | List customers |
| [`gorgias_customers_list_events`](#gorgias_customers_list_events) | List events |
| [`gorgias_customers_merge_customers`](#gorgias_customers_merge_customers) | Merge two customers |
| [`gorgias_customers_post_api_reporting_stats`](#gorgias_customers_post_api_reporting_stats) | Retrieve a statistic |
| [`gorgias_customers_post_api_stats_name`](#gorgias_customers_post_api_stats_name) | Retrieve a statistic |
| [`gorgias_customers_post_api_stats_name_download`](#gorgias_customers_post_api_stats_name_download) | Download a statistic |
| [`gorgias_customers_post_api_upload`](#gorgias_customers_post_api_upload) | Upload files |
| [`gorgias_customers_search`](#gorgias_customers_search) | Search for resources |
| [`gorgias_customers_update_custom_field`](#gorgias_customers_update_custom_field) | Update a custom field |
| [`gorgias_customers_update_custom_fields`](#gorgias_customers_update_custom_fields) | Bulk update a list of custom fields |
| [`gorgias_customers_update_customer`](#gorgias_customers_update_customer) | Update a customer |
| [`gorgias_customers_update_customer_custom_field_value`](#gorgias_customers_update_customer_custom_field_value) | Update customer field value |
| [`gorgias_customers_update_customer_custom_field_values`](#gorgias_customers_update_customer_custom_field_values) | Update customer fields values |
| [`gorgias_customers_update_customer_data`](#gorgias_customers_update_customer_data) | Set customer data |
***
## gorgias\_customers\_create\_custom\_field
Create a custom field
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------- | --------------------------------------------------------- |
| `deactivated_datetime` | string | null | No | — | When the custom field was deactivated. |
| `definition` | object | Yes | — | The settings for this custom field, dependent on the data type. | |
| `description` | string | null | No | — | The description of the custom field. |
| `external_id` | string | null | No | — | ID of the custom field in a foreign system (ex: Zendesk). |
| `label` | string | Yes | — | The name of the custom field. | |
| `managed_type` | object | No | — | The type of the managed field. | |
| `object_type` | string | Yes | — | Object Type | |
| `priority` | integer | null | No | — | Order in which custom fields are displayed. |
| `required` | boolean | No | — | Whether this custom field is required. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"deactivated_datetime": {
"type": [
"string",
"null"
],
"description": "When the custom field was deactivated."
},
"definition": {
"description": "The settings for this custom field, dependent on the data type."
},
"description": {
"type": [
"string",
"null"
],
"description": "The description of the custom field."
},
"external_id": {
"type": [
"string",
"null"
],
"description": "ID of the custom field in a foreign system (ex: Zendesk)."
},
"label": {
"type": "string",
"description": "The name of the custom field."
},
"managed_type": {
"description": "The type of the managed field."
},
"object_type": {
"type": "string",
"description": "Object Type",
"enum": [
"Ticket",
"Customer"
]
},
"priority": {
"type": [
"integer",
"null"
],
"description": "Order in which custom fields are displayed."
},
"required": {
"type": "boolean",
"description": "Whether this custom field is required."
}
},
"required": [
"PCID",
"definition",
"label",
"object_type"
]
}
```
***
## gorgias\_customers\_create\_customer
Create a customer
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------- | --------- | -------- | ------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `channels` | object\[] | Yes | — | The customer's contact channels. | |
| `email` | string | null | No | — | Primary email address of the customer. |
| `external_id` | string | null | No | — | ID of the customer 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 customer's preferred language (format: ISO\_639-1). |
| `name` | string | null | No | — | Full name of the customer. |
| `timezone` | string | null | No | — | The customer's preferred timezone (format: IANA timezone name). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Address of the customer channel. Depending on the type it can be an email address, a phone number, a Facebook user ID, etc..."
},
"preferred": {
"type": "boolean",
"description": "Whether this is the preferred (primary) channel to contact this customer."
},
"type": {
"type": "string",
"description": "Either the slug of a non-legacy channel or one of email,phone,chat,twitter,facebook,instagram,instagram-direct-message,whatsapp"
}
},
"required": [
"address",
"preferred",
"type"
]
},
"description": "The [customer's contact channels](#the-customerchannel-object)."
},
"email": {
"type": [
"string",
"null"
],
"description": "Primary email address of the customer."
},
"external_id": {
"type": [
"string",
"null"
],
"description": "ID of the customer 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 customer's preferred language (format: ISO_639-1).",
"enum": [
"aa",
"ab",
"af",
"ak",
"sq",
"am",
"ar",
"an",
"hy",
"as",
"av",
"ae",
"ay",
"az",
"ba",
"bm",
"eu",
"be",
"bn",
"bh",
"bi",
"bs",
"br",
"bg",
"my",
"ca",
"ch",
"ce",
"zh",
"cu",
"cv",
"kw",
"co",
"cr",
"cs",
"da",
"dv",
"nl",
"dz",
"en",
"eo",
"et",
"ee",
"fo",
"fj",
"fi",
"fr",
"fy",
"ff",
"ka",
"de",
"gd",
"ga",
"gl",
"gv",
"el",
"gn",
"gu",
"ht",
"ha",
"he",
"hz",
"hi",
"ho",
"hr",
"hu",
"ig",
"is",
"io",
"ii",
"iu",
"ie",
"ia",
"id",
"ik",
"it",
"jv",
"ja",
"kl",
"kn",
"ks",
"kr",
"kk",
"km",
"ki",
"rw",
"ky",
"kv",
"kg",
"ko",
"kj",
"ku",
"lo",
"la",
"lv",
"li",
"ln",
"lt",
"lb",
"lu",
"lg",
"mk",
"mh",
"ml",
"mi",
"mr",
"ms",
"mg",
"mt",
"mn",
"na",
"nv",
"nr",
"nd",
"ng",
"ne",
"nn",
"nb",
"no",
"ny",
"oc",
"oj",
"or",
"om",
"os",
"pa",
"fa",
"pi",
"pl",
"pt",
"ps",
"qu",
"rc",
"rm",
"ro",
"rn",
"ru",
"sg",
"sa",
"si",
"sk",
"sl",
"se",
"sm",
"sn",
"sd",
"so",
"st",
"es",
"sc",
"sr",
"ss",
"su",
"sw",
"sv",
"ty",
"ta",
"tt",
"te",
"tg",
"tl",
"th",
"bo",
"ti",
"to",
"tn",
"ts",
"tk",
"tr",
"tw",
"ug",
"uk",
"ur",
"uz",
"ve",
"vi",
"vo",
"cy",
"wa",
"wo",
"xh",
"yi",
"yo",
"za",
"zu"
]
},
"name": {
"type": [
"string",
"null"
],
"description": "Full name of the customer."
},
"timezone": {
"type": [
"string",
"null"
],
"description": "The customer's preferred timezone (format: IANA timezone name).",
"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",
"channels"
]
}
```
***
## gorgias\_customers\_delete\_customer
Delete a customer
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------------------- |
| `id` | integer | Yes | — | The ID of the customer to delete. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the customer to delete."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## gorgias\_customers\_delete\_customer\_custom\_field\_value
Delete customer field value
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------- |
| `customer_id` | integer | Yes | — | The ID of the customer. |
| `id` | integer | Yes | — | The ID of the custom field. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "integer",
"description": "The ID of the customer."
},
"id": {
"type": "integer",
"description": "The ID of the custom field."
}
},
"required": [
"PCID",
"customer_id",
"id"
]
}
```
***
## gorgias\_customers\_delete\_customers
Delete customers
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ---------- | -------- | ------- | --------------------------------- |
| `ids` | integer\[] | Yes | — | A list of customer IDs to delete. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "A list of customer IDs to delete."
}
},
"required": [
"PCID",
"ids"
]
}
```
***
## gorgias\_customers\_download\_file
Download a file
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | -------------------------------------------------------------------- |
| `file_type` | string | Yes | — | The type of file to download |
| `domain_hash` | string | Yes | — | The domain identifier of the account that owns the resource |
| `resource_name` | string | Yes | — | The resource identifier of the attachment you are trying to retrieve |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"file_type": {
"type": "string",
"description": "The type of file to download"
},
"domain_hash": {
"type": "string",
"description": "The domain identifier of the account that owns the resource"
},
"resource_name": {
"type": "string",
"description": "The resource identifier of the attachment you are trying to retrieve"
}
},
"required": [
"PCID",
"file_type",
"domain_hash",
"resource_name"
]
}
```
***
## gorgias\_customers\_get\_custom\_field
Retrieve a custom field
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------------------------- |
| `id` | integer | Yes | — | The ID of the custom field to retrieve. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the custom field to retrieve."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## gorgias\_customers\_get\_customer
Retrieve a customer
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | ------------------------------------------------------------ |
| `id` | integer | Yes | — | The ID of the customer to retrieve. |
| `relationships` | object\[] | No | — | Names of relations that should be included in returned data. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the customer to retrieve."
},
"relationships": {
"type": "array",
"items": {
"enum": [
"custom_fields"
]
},
"description": "Names of relations that should be included in returned data."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## gorgias\_customers\_get\_event
Retrieve an event
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | -------------------------------- |
| `id` | integer | Yes | — | The ID of the event to retrieve. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the event to retrieve."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## gorgias\_customers\_list\_custom\_fields
List custom fields
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| `object_type` | string | Yes | — | Type of entity on which to use this custom field. |
| `search` | string | No | — | Search for custom fields' names matching the given text query (case insensitive). |
| `archived` | boolean | No | — | A filter parameter used to return archived or non-archived only results. |
| `order_by` | string | No | — | Attribute used to priority the errors. |
| `cursor` | string | No | — | Value indicating your position in the list of all items. If omitted, the first items of the list will be returned. |
| `limit` | integer | No | — | Maximum number of items to return. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"object_type": {
"type": "string",
"description": "Type of entity on which to use this custom field.",
"enum": [
"Ticket",
"Customer"
]
},
"search": {
"type": "string",
"description": "Search for custom fields' names matching the given text query (case insensitive)."
},
"archived": {
"type": "boolean",
"description": "A filter parameter used to return archived or non-archived only results."
},
"order_by": {
"type": "string",
"description": "Attribute used to priority the errors.",
"enum": [
"priority:asc",
"priority:desc"
]
},
"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."
},
"limit": {
"type": "integer",
"description": "Maximum number of items to return."
}
},
"required": [
"PCID",
"object_type"
]
}
```
***
## gorgias\_customers\_list\_customer\_custom\_fields\_values
List customer field values
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ----------------------- |
| `customer_id` | integer | Yes | — | The ID of the customer. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "integer",
"description": "The ID of the customer."
}
},
"required": [
"PCID",
"customer_id"
]
}
```
***
## gorgias\_customers\_list\_customers
List customers
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | Value indicating your position in the list of all customers. If omitted, the first customers of the list will be returned. |
| `email` | string | No | — | Primary email address of the customer you're looking for. |
| `external_id` | string | No | — | ID of the customer in a foreign system (Stripe, Aircall etc.) you're looking for. |
| `language` | string | No | — | The customer's preferred language (format: ISO\_639-1) to filter with. |
| `limit` | integer | No | — | Maximum number of customers to return. |
| `name` | string | No | — | Full name of the customer you're looking for. |
| `order_by` | string | No | — | Attribute used to order customers. |
| `timezone` | string | No | — | The customer's preferred timezone (format: IANA timezone name). |
| `view_id` | integer | No | — | ID of a view to filter customers by. |
| `channel_type` | string | No | — | Filter customers by their customer channel types. |
| `channel_address` | string | No | — | Filter customers by their customer channel addresses. |
```json theme={null}
{
"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 customers. If omitted, the first customers of the list will be returned."
},
"email": {
"type": "string",
"description": "Primary email address of the customer you're looking for."
},
"external_id": {
"type": "string",
"description": "ID of the customer in a foreign system (Stripe, Aircall etc.) you're looking for."
},
"language": {
"type": "string",
"description": "The customer's preferred language (format: ISO_639-1) to filter with.",
"enum": [
"aa",
"ab",
"af",
"ak",
"sq",
"am",
"ar",
"an",
"hy",
"as",
"av",
"ae",
"ay",
"az",
"ba",
"bm",
"eu",
"be",
"bn",
"bh",
"bi",
"bs",
"br",
"bg",
"my",
"ca",
"ch",
"ce",
"zh",
"cu",
"cv",
"kw",
"co",
"cr",
"cs",
"da",
"dv",
"nl",
"dz",
"en",
"eo",
"et",
"ee",
"fo",
"fj",
"fi",
"fr",
"fy",
"ff",
"ka",
"de",
"gd",
"ga",
"gl",
"gv",
"el",
"gn",
"gu",
"ht",
"ha",
"he",
"hz",
"hi",
"ho",
"hr",
"hu",
"ig",
"is",
"io",
"ii",
"iu",
"ie",
"ia",
"id",
"ik",
"it",
"jv",
"ja",
"kl",
"kn",
"ks",
"kr",
"kk",
"km",
"ki",
"rw",
"ky",
"kv",
"kg",
"ko",
"kj",
"ku",
"lo",
"la",
"lv",
"li",
"ln",
"lt",
"lb",
"lu",
"lg",
"mk",
"mh",
"ml",
"mi",
"mr",
"ms",
"mg",
"mt",
"mn",
"na",
"nv",
"nr",
"nd",
"ng",
"ne",
"nn",
"nb",
"no",
"ny",
"oc",
"oj",
"or",
"om",
"os",
"pa",
"fa",
"pi",
"pl",
"pt",
"ps",
"qu",
"rc",
"rm",
"ro",
"rn",
"ru",
"sg",
"sa",
"si",
"sk",
"sl",
"se",
"sm",
"sn",
"sd",
"so",
"st",
"es",
"sc",
"sr",
"ss",
"su",
"sw",
"sv",
"ty",
"ta",
"tt",
"te",
"tg",
"tl",
"th",
"bo",
"ti",
"to",
"tn",
"ts",
"tk",
"tr",
"tw",
"ug",
"uk",
"ur",
"uz",
"ve",
"vi",
"vo",
"cy",
"wa",
"wo",
"xh",
"yi",
"yo",
"za",
"zu"
]
},
"limit": {
"type": "integer",
"description": "Maximum number of customers to return."
},
"name": {
"type": "string",
"description": "Full name of the customer you're looking for."
},
"order_by": {
"type": "string",
"description": "Attribute used to order customers.",
"enum": [
"created_datetime:asc",
"created_datetime:desc",
"updated_datetime:asc",
"updated_datetime:desc"
]
},
"timezone": {
"type": "string",
"description": "The customer's preferred timezone (format: IANA timezone name).",
"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"
]
},
"view_id": {
"type": "integer",
"description": "ID of a view to filter customers by."
},
"channel_type": {
"type": "string",
"description": "Filter customers by their customer channel types."
},
"channel_address": {
"type": "string",
"description": "Filter customers by their customer channel addresses."
}
},
"required": [
"PCID"
]
}
```
***
## gorgias\_customers\_list\_events
List events
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `created_datetime` | object | No | — | Comparators used to filter events on their creation date. |
| `cursor` | string | No | — | Value indicating your position in the list of all events. If omitted, the first events of the list will be returned. |
| `limit` | integer | No | — | Maximum number of events to return. |
| `object_id` | integer | No | — | ID of the object associated with the events to return. |
| `object_type` | string | No | — | Type of the object associated with the events to return. |
| `order_by` | string | No | — | Attribute used to order events.\
Value of \`created_datetime` has been deprecated\, use `created_datetime:asc` or `created_datetime:desc` instead. |
| `types` | string\[] | No | — | Types of the events to return. |
| `user_ids` | integer\[] | No | — | IDs of the users who triggered the events to return. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"created_datetime": {
"type": "object",
"description": "Comparators used to filter events on their creation date.",
"properties": {
"gt": {
"type": "string",
"description": "Greater than then given value."
},
"gte": {
"type": "string",
"description": "Greater than or equal to the given value."
},
"lt": {
"type": "string",
"description": "Less than the given value."
},
"lte": {
"type": "string",
"description": "Less than or equal to the given value."
}
}
},
"cursor": {
"type": "string",
"description": "Value indicating your position in the list of all events. If omitted, the first events of the list will be returned."
},
"limit": {
"type": "integer",
"description": "Maximum number of events to return."
},
"object_id": {
"type": "integer",
"description": "ID of the object associated with the events to return."
},
"object_type": {
"type": "string",
"description": "Type of the object associated with the events to return.",
"enum": [
"Account",
"Macro",
"Tag",
"Customer",
"Team",
"View",
"Widget",
"User",
"TicketMessage",
"Ticket",
"Rule",
"Integration",
"SatisfactionSurvey"
]
},
"order_by": {
"type": "string",
"description": "Attribute used to order events.
Value of `created_datetime` has been deprecated, use `created_datetime:asc` or `created_datetime:desc` instead.",
"enum": [
"created_datetime",
"created_datetime:asc",
"created_datetime:desc"
]
},
"types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"account-created",
"account-deactivated",
"account-updated",
"customer-created",
"customer-deleted",
"customer-merged",
"customer-updated",
"integration-created",
"integration-deleted",
"integration-updated",
"macro-created",
"macro-deleted",
"macro-updated",
"rule-created",
"rule-deleted",
"rule-updated",
"satisfaction-survey-responded",
"satisfaction-survey-sent",
"tag-created",
"tag-deleted",
"tag-merged",
"team-created",
"team-deleted",
"team-updated",
"ticket-assigned",
"ticket-closed",
"ticket-created",
"ticket-customer-updated",
"ticket-deleted",
"ticket-excluded-from-auto-merge",
"ticket-excluded-from-csat",
"ticket-marked-spam",
"ticket-merged",
"ticket-message-created",
"ticket-message-deleted",
"ticket-message-failed",
"ticket-message-summary-created",
"ticket-message-updated",
"ticket-reopened",
"ticket-satisfaction-survey-skipped",
"ticket-self-unsnoozed",
"ticket-snoozed",
"ticket-split",
"ticket-subject-updated",
"ticket-tags-added",
"ticket-tags-removed",
"ticket-team-assigned",
"ticket-team-unassigned",
"ticket-trashed",
"ticket-unassigned",
"ticket-unmarked-spam",
"ticket-untrashed",
"ticket-updated",
"user-created",
"user-deleted",
"user-invited",
"user-logged-in",
"user-logged-out",
"user-password-changed",
"user-password-reset",
"user-updated",
"view-created",
"view-deleted",
"view-updated",
"widget-created",
"widget-deleted",
"widget-updated"
]
},
"description": "Types of the events to return."
},
"user_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of the users who triggered the events to return."
}
},
"required": [
"PCID"
]
}
```
***
## gorgias\_customers\_merge\_customers
Merge two customers
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `source_id` | integer | Yes | — | The ID of the customer to merge (which will be merged into the targeted customer). | |
| `target_id` | integer | Yes | — | The ID of the targeted customer (which will still be here after the merge). | |
| `active` | boolean | No | — | A convenience field that indicates if the customer is active. This field is read-only. If you want to deactivate a customer you can set the deactivated\_datetime field | |
| `channels` | object\[] | No | — | A list of CustomerChannel objects. Each channel represents a way to communicate with a customer. Example: email, phone, facebook, etc... | |
| `created_datetime` | string | null | No | — | When the customer was created. |
| `custom_fields` | object | No | — | The custom fields associated with the customer. | |
| `customer` | object | No | — | The customer value | |
| `data` | object | No | — | User defined JSON field. It can be useful for storing additional info about the object. \This parameter has been deprecated.\ | |
| `ecommerce_data` | object | No | — | Ecommerce data associated with the customer | |
| `email` | string | null | No | — | Primary email address of the customer |
| `external_id` | string | null | No | — | External id can be used to identify this customer in a foreign system. This field is not used by Gorgias, feel free to set it as you wish. |
| `firstname` | string | No | — | First name of the customer. This field is read-only and generated using the name field | |
| `id` | integer | No | — | ID of the object | |
| `integrations` | object | No | — | A list of integration data rows that this customer has. For example a customer can have Shopify integration data (orders, payments, etc...) | |
| `language` | string | null | No | — | The preferred language of the customer. We're using ISO\_639-1 codes from this list: [https://en.wikipedia.org/wiki/List\_of\_ISO\_639-1\_codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `lastname` | string | No | — | Last name of the customer. This field is read-only and generated using the name field | |
| `meta` | object | No | — | User defined JSON field. It can be useful for storing additional info about the object. | |
| `name` | string | null | No | — | Full name of the customer |
| `note` | string | null | No | — | A note describing the customer. |
| `timezone` | string | null | No | — | Timezone of the customer. We're using timezones defined on this list: [https://en.wikipedia.org/wiki/List\_of\_tz\_database\_time\_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) |
| `updated_datetime` | string | null | No | — | When the customer was last updated. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "integer",
"description": "The ID of the customer to merge (which will be merged into the targeted customer)."
},
"target_id": {
"type": "integer",
"description": "The ID of the targeted customer (which will still be here after the merge)."
},
"active": {
"type": "boolean",
"description": "A convenience field that indicates if the customer is active. This field is read-only. If you want to deactivate a customer you can set the deactivated_datetime field"
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Address can be email, phone, facebook id, etc..."
},
"created_datetime": {
"type": "string",
"format": "date-time",
"description": "When the user channel was created."
},
"customer": {
"type": "object",
"description": "The customer value"
},
"deleted_datetime": {
"type": "string",
"format": "date-time",
"description": "Deleted Datetime"
},
"id": {
"type": "integer",
"description": "ID of the object"
},
"preferred": {
"type": "boolean",
"description": "Is this the preferred or (primary) channel to contact this user."
},
"type": {
"type": "string",
"description": "Either the slug of a non-legacy channel or one of email,phone,chat,twitter,facebook,instagram,instagram-direct-message,whatsapp"
},
"updated_datetime": {
"type": "string",
"format": "date-time",
"description": "When the user channel was last updated."
},
"user": {
"type": "object",
"description": "The user value"
}
},
"required": [
"address",
"type"
]
},
"description": "A list of [CustomerChannel](#CustomerChannel-object) objects. Each channel represents a way to communicate with a customer. Example: email, phone, facebook, etc..."
},
"created_datetime": {
"type": [
"string",
"null"
],
"description": "When the customer was created."
},
"custom_fields": {
"type": "object",
"description": "The custom fields associated with the customer."
},
"customer": {
"description": "The customer value"
},
"data": {
"type": "object",
"description": "User defined JSON field. It can be useful for storing additional info about the object. This parameter has been deprecated."
},
"ecommerce_data": {
"type": "object",
"description": "Ecommerce data associated with the customer"
},
"email": {
"type": [
"string",
"null"
],
"description": "Primary email address of the customer"
},
"external_id": {
"type": [
"string",
"null"
],
"description": "External id can be used to identify this customer in a foreign system. This field is not used by Gorgias, feel free to set it as you wish."
},
"firstname": {
"type": "string",
"description": "First name of the customer. This field is read-only and generated using the name field"
},
"id": {
"type": "integer",
"description": "ID of the object"
},
"integrations": {
"type": "object",
"description": "A list of integration data rows that this customer has. For example a customer can have Shopify integration data (orders, payments, etc...)",
"properties": {
"bigcommerce": {
"type": "object",
"description": "The bigcommerce value"
},
"magento2": {
"type": "object",
"description": "The magento2 value"
},
"other": {
"type": "string",
"description": "The other value"
},
"recharge": {
"type": "object",
"description": "The recharge value"
},
"shopify": {
"type": "object",
"description": "The shopify value"
},
"smile": {
"type": "object",
"description": "The smile value"
}
}
},
"language": {
"type": [
"string",
"null"
],
"description": "The preferred language of the customer. We're using ISO_639-1 codes from this list: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes"
},
"lastname": {
"type": "string",
"description": "Last name of the customer. This field is read-only and generated using the name field"
},
"meta": {
"type": "object",
"description": "User defined JSON field. It can be useful for storing additional info about the object."
},
"name": {
"type": [
"string",
"null"
],
"description": "Full name of the customer"
},
"note": {
"type": [
"string",
"null"
],
"description": "A note describing the customer."
},
"timezone": {
"type": [
"string",
"null"
],
"description": "Timezone of the customer. We're using timezones defined on this list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"
},
"updated_datetime": {
"type": [
"string",
"null"
],
"description": "When the customer was last updated."
}
},
"required": [
"PCID",
"source_id",
"target_id"
]
}
```
***
## gorgias\_customers\_post\_api\_reporting\_stats
Retrieve a statistic
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `cursor` | string | No | — | Value indicating your position in the list of all analytics results. If omitted, the first analytics results of the list will be returned. |
| `limit` | integer | No | — | Maximum number of analytics results to return. |
| `query` | object | Yes | — | The statistics query, dependent on the requested metric. |
```json theme={null}
{
"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 analytics results. If omitted, the first analytics results of the list will be returned."
},
"limit": {
"type": "integer",
"description": "Maximum number of analytics results to return."
},
"query": {
"description": "The statistics query, dependent on the requested metric."
}
},
"required": [
"PCID",
"query"
]
}
```
***
## gorgias\_customers\_post\_api\_stats\_name
Retrieve a statistic
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------ |
| `name` | string | Yes | — | The name of the statistic to retrieve. |
| `filters` | object | Yes | — | Miscellaneous criteria to define the scope of the statistic. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "The name of the statistic to retrieve.",
"enum": [
"overview",
"total-tickets-created",
"total-tickets-replied",
"total-tickets-closed",
"total-messages-sent",
"total-messages-received",
"median-first-response-time",
"median-resolution-time",
"total-one-touch-tickets",
"support-volume",
"resolution-time",
"first-response-time",
"tickets-created-per-hour-per-weekday",
"tickets-per-tag",
"tickets-created-per-channel",
"tickets-created-per-channel-per-day",
"tickets-closed-per-agent",
"tickets-closed-per-agent-per-day",
"messages-sent-per-macro",
"satisfaction-surveys",
"latest-satisfaction-surveys",
"intents-occurrence",
"intents-overview",
"intents-breakdown-per-day",
"revenue-overview",
"revenue-per-agent",
"revenue-per-day",
"revenue-per-ticket",
"self-service-volume-per-flow",
"self-service-article-recommendation-performance",
"self-service-top-reported-issues",
"self-service-products-with-most-issues-and-return-requests",
"self-service-workflows-performance"
]
},
"filters": {
"type": "object",
"description": "Miscellaneous criteria to define the scope of the statistic.",
"properties": {
"agents": {
"type": "array",
"items": {
"type": "integer"
},
"description": "ID of users to filter the statistic by."
},
"campaigns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Campaigns to filter the statistic by."
},
"channels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Channels to filter the statistic by."
},
"integrations": {
"type": "array",
"items": {
"type": "integer"
},
"description": "ID of integrations to filter the statistic by."
},
"period": {
"type": "object",
"description": "Time period to filter the statistic by."
},
"score": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Satisfaction survey scores to filter the statistic by."
},
"tags": {
"type": "array",
"items": {
"type": "integer"
},
"description": "ID of tags to filter the statistic by."
}
}
}
},
"required": [
"PCID",
"name",
"filters"
]
}
```
***
## gorgias\_customers\_post\_api\_stats\_name\_download
Download a statistic
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------ |
| `name` | string | Yes | — | The name of the statistic to retrieve. |
| `filters` | object | Yes | — | Miscellaneous criteria to define the scope of the statistic. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "The name of the statistic to retrieve.",
"enum": [
"overview",
"total-tickets-created",
"total-tickets-replied",
"total-tickets-closed",
"total-messages-sent",
"total-messages-received",
"median-first-response-time",
"median-resolution-time",
"total-one-touch-tickets",
"support-volume",
"resolution-time",
"first-response-time",
"tickets-created-per-hour-per-weekday",
"tickets-per-tag",
"tickets-created-per-channel",
"tickets-created-per-channel-per-day",
"tickets-closed-per-agent",
"tickets-closed-per-agent-per-day",
"messages-sent-per-macro",
"satisfaction-surveys",
"latest-satisfaction-surveys",
"intents-occurrence",
"intents-overview",
"intents-breakdown-per-day",
"revenue-overview",
"revenue-per-agent",
"revenue-per-day",
"revenue-per-ticket",
"self-service-volume-per-flow",
"self-service-article-recommendation-performance",
"self-service-top-reported-issues",
"self-service-products-with-most-issues-and-return-requests",
"self-service-workflows-performance"
]
},
"filters": {
"type": "object",
"description": "Miscellaneous criteria to define the scope of the statistic.",
"properties": {
"agents": {
"type": "array",
"items": {
"type": "integer"
},
"description": "ID of users to filter the statistic by."
},
"campaigns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Campaigns to filter the statistic by."
},
"channels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Channels to filter the statistic by."
},
"integrations": {
"type": "array",
"items": {
"type": "integer"
},
"description": "ID of integrations to filter the statistic by."
},
"period": {
"type": "object",
"description": "Time period to filter the statistic by."
},
"score": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Satisfaction survey scores to filter the statistic by."
},
"tags": {
"type": "array",
"items": {
"type": "integer"
},
"description": "ID of tags to filter the statistic by."
}
}
}
},
"required": [
"PCID",
"name",
"filters"
]
}
```
***
## gorgias\_customers\_post\_api\_upload
Upload files
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | string | No | — | The type of file to upload. If not specified, the file will be uploaded as a private attachment. |
| `file` | string | No | — | A file to upload. The name of this parameter can be replaced with the label of the file you want to have once uploaded. E.g: `package-damaged.png`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"type": {
"type": "string",
"description": "The type of file to upload. If not specified, the file will be uploaded as a private attachment.",
"enum": [
"public_attachment",
"attachment",
"profile_picture",
"widget_picture"
]
},
"file": {
"type": "string",
"description": "A file to upload. The name of this parameter can be replaced with the label of the file you want to have once uploaded. E.g: `package-damaged.png`."
}
},
"required": [
"PCID"
]
}
```
***
## gorgias\_customers\_search
Search for resources
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query` | string | No | — | Text query used to search for resources. |
| `size` | integer | No | — | Maximum number of results returned. |
| `type` | string | Yes | — | The type of search. Supported types: - `customer`: Search in customers' names and emails - `customer_profile`: Search in customers' names, emails, and channels' addresses (phones, emails, etc...) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"query": {
"type": "string",
"description": "Text query used to search for resources."
},
"size": {
"type": "integer",
"description": "Maximum number of results returned."
},
"type": {
"type": "string",
"description": "The type of search. Supported types: - `customer`: Search in customers' names and emails - `customer_profile`: Search in customers' names, emails, and channels' addresses (phones, emails, etc...)",
"enum": [
"agent",
"customer",
"customer_profile",
"customer_channel",
"customer_channel_email",
"customer_channel_phone",
"customers_by_phone",
"integration",
"team",
"tag"
]
}
},
"required": [
"PCID",
"type"
]
}
```
***
## gorgias\_customers\_update\_custom\_field
Update a custom field
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------- | --------------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the custom field to update. | |
| `deactivated_datetime` | string | null | No | — | When the custom field was deactivated. |
| `definition` | object | No | — | The settings for this custom field, dependent on the data type. | |
| `description` | string | null | No | — | The description of the custom field. |
| `external_id` | string | null | No | — | ID of the custom field in a foreign system (ex: Zendesk). |
| `label` | string | No | — | The name of the custom field. | |
| `managed_type` | object | No | — | The type of the managed field. | |
| `object_type` | string | No | — | Object Type | |
| `priority` | integer | No | — | Order in which custom fields are displayed. | |
| `required` | boolean | No | — | Whether this custom field is required. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the custom field to update."
},
"deactivated_datetime": {
"type": [
"string",
"null"
],
"description": "When the custom field was deactivated."
},
"definition": {
"description": "The settings for this custom field, dependent on the data type."
},
"description": {
"type": [
"string",
"null"
],
"description": "The description of the custom field."
},
"external_id": {
"type": [
"string",
"null"
],
"description": "ID of the custom field in a foreign system (ex: Zendesk)."
},
"label": {
"type": "string",
"description": "The name of the custom field."
},
"managed_type": {
"description": "The type of the managed field."
},
"object_type": {
"type": "string",
"description": "Object Type",
"enum": [
"Ticket",
"Customer"
]
},
"priority": {
"type": "integer",
"description": "Order in which custom fields are displayed."
},
"required": {
"type": "boolean",
"description": "Whether this custom field is required."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## gorgias\_customers\_update\_custom\_fields
Bulk update a list of custom fields
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | ------------ |
| `body` | object\[] | Yes | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"deactivated_datetime": {
"type": "string",
"format": "date-time",
"description": "When the custom field was deactivated."
},
"definition": {
"description": "The settings for this custom field, dependent on the data type."
},
"description": {
"type": "string",
"description": "The description of the custom field."
},
"external_id": {
"type": "string",
"description": "ID of the custom field in a foreign system (ex: Zendesk)."
},
"id": {
"type": "integer",
"description": "The id value"
},
"label": {
"type": "string",
"description": "The name of the custom field."
},
"managed_type": {
"description": "The type of the managed field."
},
"object_type": {
"type": "string",
"enum": [
"Ticket",
"Customer"
],
"description": "Object Type"
},
"priority": {
"type": "integer",
"description": "Order in which custom fields are displayed."
},
"required": {
"type": "boolean",
"description": "Whether this custom field is required."
},
"requirement_type": {
"type": "string",
"enum": [
"visible",
"required",
"conditional"
],
"description": "Requirement Type"
}
},
"required": [
"id"
]
},
"description": "Request body"
}
},
"required": [
"PCID",
"body"
]
}
```
***
## gorgias\_customers\_update\_customer
Update a customer
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------- | --------- | -------- | ------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the customer to update. | |
| `channels` | object\[] | No | — | The customer's contact channels. | |
| `email` | string | null | No | — | Primary email address of the customer. |
| `external_id` | string | null | No | — | ID of the customer 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 customer's preferred language (format: ISO\_639-1). |
| `name` | string | null | No | — | Full name of the customer. |
| `timezone` | string | null | No | — | The customer's preferred timezone (format: IANA timezone name). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the customer to update."
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Address of the customer channel. Depending on the type it can be an email address, a phone number, a Facebook user ID, etc..."
},
"preferred": {
"type": "boolean",
"description": "Whether this is the preferred (primary) channel to contact this customer."
},
"type": {
"type": "string",
"description": "Either the slug of a non-legacy channel or one of email,phone,chat,twitter,facebook,instagram,instagram-direct-message,whatsapp"
}
},
"required": [
"address",
"preferred",
"type"
]
},
"description": "The [customer's contact channels](#the-customerchannel-object)."
},
"email": {
"type": [
"string",
"null"
],
"description": "Primary email address of the customer."
},
"external_id": {
"type": [
"string",
"null"
],
"description": "ID of the customer 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 customer's preferred language (format: ISO_639-1).",
"enum": [
"aa",
"ab",
"af",
"ak",
"sq",
"am",
"ar",
"an",
"hy",
"as",
"av",
"ae",
"ay",
"az",
"ba",
"bm",
"eu",
"be",
"bn",
"bh",
"bi",
"bs",
"br",
"bg",
"my",
"ca",
"ch",
"ce",
"zh",
"cu",
"cv",
"kw",
"co",
"cr",
"cs",
"da",
"dv",
"nl",
"dz",
"en",
"eo",
"et",
"ee",
"fo",
"fj",
"fi",
"fr",
"fy",
"ff",
"ka",
"de",
"gd",
"ga",
"gl",
"gv",
"el",
"gn",
"gu",
"ht",
"ha",
"he",
"hz",
"hi",
"ho",
"hr",
"hu",
"ig",
"is",
"io",
"ii",
"iu",
"ie",
"ia",
"id",
"ik",
"it",
"jv",
"ja",
"kl",
"kn",
"ks",
"kr",
"kk",
"km",
"ki",
"rw",
"ky",
"kv",
"kg",
"ko",
"kj",
"ku",
"lo",
"la",
"lv",
"li",
"ln",
"lt",
"lb",
"lu",
"lg",
"mk",
"mh",
"ml",
"mi",
"mr",
"ms",
"mg",
"mt",
"mn",
"na",
"nv",
"nr",
"nd",
"ng",
"ne",
"nn",
"nb",
"no",
"ny",
"oc",
"oj",
"or",
"om",
"os",
"pa",
"fa",
"pi",
"pl",
"pt",
"ps",
"qu",
"rc",
"rm",
"ro",
"rn",
"ru",
"sg",
"sa",
"si",
"sk",
"sl",
"se",
"sm",
"sn",
"sd",
"so",
"st",
"es",
"sc",
"sr",
"ss",
"su",
"sw",
"sv",
"ty",
"ta",
"tt",
"te",
"tg",
"tl",
"th",
"bo",
"ti",
"to",
"tn",
"ts",
"tk",
"tr",
"tw",
"ug",
"uk",
"ur",
"uz",
"ve",
"vi",
"vo",
"cy",
"wa",
"wo",
"xh",
"yi",
"yo",
"za",
"zu"
]
},
"name": {
"type": [
"string",
"null"
],
"description": "Full name of the customer."
},
"timezone": {
"type": [
"string",
"null"
],
"description": "The customer's preferred timezone (format: IANA timezone name).",
"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",
"id"
]
}
```
***
## gorgias\_customers\_update\_customer\_custom\_field\_value
Update customer field value
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | --------------------------- |
| `customer_id` | integer | Yes | — | The ID of the customer. |
| `id` | integer | Yes | — | The ID of the custom field. |
| `body` | object | Yes | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "integer",
"description": "The ID of the customer."
},
"id": {
"type": "integer",
"description": "The ID of the custom field."
},
"body": {
"description": "Request body"
}
},
"required": [
"PCID",
"customer_id",
"id",
"body"
]
}
```
***
## gorgias\_customers\_update\_customer\_custom\_field\_values
Update customer fields values
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | --------- | -------- | ------- | ----------------------- |
| `customer_id` | integer | Yes | — | The ID of the customer. |
| `body` | object\[] | Yes | — | Request body |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "integer",
"description": "The ID of the customer."
},
"body": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the custom field for which to set a value."
},
"value": {
"description": "The value of the custom field for the particular customer."
}
},
"required": [
"id",
"value"
]
},
"description": "Request body"
}
},
"required": [
"PCID",
"customer_id",
"body"
]
}
```
***
## gorgias\_customers\_update\_customer\_data
Set customer data
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------- | ------- | -------- | ------- | --------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `customer_id` | integer | Yes | — | The ID of the customer to update. | |
| `data` | object | No | — | The customer data. | |
| `version` | string | null | No | — | The date of the customer data. If we already have a more recent version, the request will be ignored. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "integer",
"description": "The ID of the customer to update."
},
"data": {
"description": "The customer data."
},
"version": {
"type": [
"string",
"null"
],
"description": "The date of the customer data. If we already have a more recent version, the request will be ignored."
}
},
"required": [
"PCID",
"customer_id"
]
}
```