Skip to main content
Server path: /gorgias-customers | Type: Application | PCID required: Yes

​
Tools

ToolDescription
gorgias_customers_create_custom_fieldCreate a custom field
gorgias_customers_create_customerCreate a customer
gorgias_customers_delete_customerDelete a customer
gorgias_customers_delete_customer_custom_field_valueDelete customer field value
gorgias_customers_delete_customersDelete customers
gorgias_customers_download_fileDownload a file
gorgias_customers_get_custom_fieldRetrieve a custom field
gorgias_customers_get_customerRetrieve a customer
gorgias_customers_get_eventRetrieve an event
gorgias_customers_list_custom_fieldsList custom fields
gorgias_customers_list_customer_custom_fields_valuesList customer field values
gorgias_customers_list_customersList customers
gorgias_customers_list_eventsList events
gorgias_customers_merge_customersMerge two customers
gorgias_customers_post_api_reporting_statsRetrieve a statistic
gorgias_customers_post_api_stats_nameRetrieve a statistic
gorgias_customers_post_api_stats_name_downloadDownload a statistic
gorgias_customers_post_api_uploadUpload files
gorgias_customers_searchSearch for resources
gorgias_customers_update_custom_fieldUpdate a custom field
gorgias_customers_update_custom_fieldsBulk update a list of custom fields
gorgias_customers_update_customerUpdate a customer
gorgias_customers_update_customer_custom_field_valueUpdate customer field value
gorgias_customers_update_customer_custom_field_valuesUpdate customer fields values
gorgias_customers_update_customer_dataSet customer data

​
gorgias_customers_create_custom_field

Create a custom field Parameters:
ParameterTypeRequiredDefaultDescription
deactivated_datetimestringNo—When the custom field was deactivated.
definitionobjectYes—The settings for this custom field, dependent on the data type.
descriptionstringNo—The description of the custom field.
external_idstringNo—ID of the custom field in a foreign system (ex: Zendesk).
labelstringYes—The name of the custom field.
managed_typeobjectNo—The type of the managed field.
object_typestringYes—Object Type
priorityintegerNo—Order in which custom fields are displayed.
requiredbooleanNo—Whether this custom field is required.

​
gorgias_customers_create_customer

Create a customer Parameters:
ParameterTypeRequiredDefaultDescription
channelsobject[]Yes—The customer’s contact channels.
emailstringNo—Primary email address of the customer.
external_idstringNo—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.
languagestringNo—The customer’s preferred language (format: ISO_639-1).
namestringNo—Full name of the customer.
timezonestringNo—The customer’s preferred timezone (format: IANA timezone name).

​
gorgias_customers_delete_customer

Delete a customer Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The ID of the customer to delete.

​
gorgias_customers_delete_customer_custom_field_value

Delete customer field value Parameters:
ParameterTypeRequiredDefaultDescription
customer_idintegerYes—The ID of the customer.
idintegerYes—The ID of the custom field.

​
gorgias_customers_delete_customers

Delete customers Parameters:
ParameterTypeRequiredDefaultDescription
idsinteger[]Yes—A list of customer IDs to delete.

​
gorgias_customers_download_file

Download a file Parameters:
ParameterTypeRequiredDefaultDescription
file_typestringYes—The type of file to download
domain_hashstringYes—The domain identifier of the account that owns the resource
resource_namestringYes—The resource identifier of the attachment you are trying to retrieve

​
gorgias_customers_get_custom_field

Retrieve a custom field Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The ID of the custom field to retrieve.

​
gorgias_customers_get_customer

Retrieve a customer Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The ID of the customer to retrieve.
relationshipsobject[]No—Names of relations that should be included in returned data.

​
gorgias_customers_get_event

Retrieve an event Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The ID of the event to retrieve.

​
gorgias_customers_list_custom_fields

List custom fields Parameters:
ParameterTypeRequiredDefaultDescription
object_typestringYes—Type of entity on which to use this custom field.
searchstringNo—Search for custom fields’ names matching the given text query (case insensitive).
archivedbooleanNo—A filter parameter used to return archived or non-archived only results.
order_bystringNo—Attribute used to priority the errors.
cursorstringNo—Value indicating your position in the list of all items. If omitted, the first items of the list will be returned.
limitintegerNo—Maximum number of items to return.

​
gorgias_customers_list_customer_custom_fields_values

List customer field values Parameters:
ParameterTypeRequiredDefaultDescription
customer_idintegerYes—The ID of the customer.

​
gorgias_customers_list_customers

List customers Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNo—Value indicating your position in the list of all customers. If omitted, the first customers of the list will be returned.
emailstringNo—Primary email address of the customer you’re looking for.
external_idstringNo—ID of the customer in a foreign system (Stripe, Aircall etc.) you’re looking for.
languagestringNo—The customer’s preferred language (format: ISO_639-1) to filter with.
limitintegerNo—Maximum number of customers to return.
namestringNo—Full name of the customer you’re looking for.
order_bystringNo—Attribute used to order customers.
timezonestringNo—The customer’s preferred timezone (format: IANA timezone name).
view_idintegerNo—ID of a view to filter customers by.
channel_typestringNo—Filter customers by their customer channel types.
channel_addressstringNo—Filter customers by their customer channel addresses.

​
gorgias_customers_list_events

List events Parameters:
ParameterTypeRequiredDefaultDescription
created_datetimeobjectNo—Comparators used to filter events on their creation date.
cursorstringNo—Value indicating your position in the list of all events. If omitted, the first events of the list will be returned.
limitintegerNo—Maximum number of events to return.
object_idintegerNo—ID of the object associated with the events to return.
object_typestringNo—Type of the object associated with the events to return.
order_bystringNo—Attribute used to order events.<br>Value of <span style={{color: ‘red’}}>created_datetime has been deprecated</span>, use created_datetime:asc or created_datetime:desc instead.
typesstring[]No—Types of the events to return.
user_idsinteger[]No—IDs of the users who triggered the events to return.

​
gorgias_customers_merge_customers

Merge two customers Parameters:
ParameterTypeRequiredDefaultDescription
source_idintegerYes—The ID of the customer to merge (which will be merged into the targeted customer).
target_idintegerYes—The ID of the targeted customer (which will still be here after the merge).
activebooleanNo—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
channelsobject[]No—A list of CustomerChannel objects. Each channel represents a way to communicate with a customer. Example: email, phone, facebook, etc…
created_datetimestringNo—When the customer was created.
custom_fieldsobjectNo—The custom fields associated with the customer.
customerobjectNo—The customer value
dataobjectNo—User defined JSON field. It can be useful for storing additional info about the object. <span style={{color: ‘red’}}>This parameter has been deprecated.</span>
ecommerce_dataobjectNo—Ecommerce data associated with the customer
emailstringNo—Primary email address of the customer
external_idstringNo—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.
firstnamestringNo—First name of the customer. This field is read-only and generated using the name field
idintegerNo—ID of the object
integrationsobjectNo—A list of integration data rows that this customer has. For example a customer can have Shopify integration data (orders, payments, etc…)
languagestringNo—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
lastnamestringNo—Last name of the customer. This field is read-only and generated using the name field
metaobjectNo—User defined JSON field. It can be useful for storing additional info about the object.
namestringNo—Full name of the customer
notestringNo—A note describing the customer.
timezonestringNo—Timezone of the customer. We’re using timezones defined on this list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
updated_datetimestringNo—When the customer was last updated.

​
gorgias_customers_post_api_reporting_stats

Retrieve a statistic Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNo—Value indicating your position in the list of all analytics results. If omitted, the first analytics results of the list will be returned.
limitintegerNo—Maximum number of analytics results to return.
queryobjectYes—The statistics query, dependent on the requested metric.

​
gorgias_customers_post_api_stats_name

Retrieve a statistic Parameters:
ParameterTypeRequiredDefaultDescription
namestringYes—The name of the statistic to retrieve.
filtersobjectYes—Miscellaneous criteria to define the scope of the statistic.

​
gorgias_customers_post_api_stats_name_download

Download a statistic Parameters:
ParameterTypeRequiredDefaultDescription
namestringYes—The name of the statistic to retrieve.
filtersobjectYes—Miscellaneous criteria to define the scope of the statistic.

​
gorgias_customers_post_api_upload

Upload files Parameters:
ParameterTypeRequiredDefaultDescription
typestringNo—The type of file to upload. If not specified, the file will be uploaded as a private attachment.
filestringNo—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.
Search for resources Parameters:
ParameterTypeRequiredDefaultDescription
querystringNo—Text query used to search for resources.
sizeintegerNo—Maximum number of results returned.
typestringYes—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…)

​
gorgias_customers_update_custom_field

Update a custom field Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The ID of the custom field to update.
deactivated_datetimestringNo—When the custom field was deactivated.
definitionobjectNo—The settings for this custom field, dependent on the data type.
descriptionstringNo—The description of the custom field.
external_idstringNo—ID of the custom field in a foreign system (ex: Zendesk).
labelstringNo—The name of the custom field.
managed_typeobjectNo—The type of the managed field.
object_typestringNo—Object Type
priorityintegerNo—Order in which custom fields are displayed.
requiredbooleanNo—Whether this custom field is required.

​
gorgias_customers_update_custom_fields

Bulk update a list of custom fields Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]Yes—Request body

​
gorgias_customers_update_customer

Update a customer Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The ID of the customer to update.
channelsobject[]No—The customer’s contact channels.
emailstringNo—Primary email address of the customer.
external_idstringNo—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.
languagestringNo—The customer’s preferred language (format: ISO_639-1).
namestringNo—Full name of the customer.
timezonestringNo—The customer’s preferred timezone (format: IANA timezone name).

​
gorgias_customers_update_customer_custom_field_value

Update customer field value Parameters:
ParameterTypeRequiredDefaultDescription
customer_idintegerYes—The ID of the customer.
idintegerYes—The ID of the custom field.
bodyobjectYes—Request body

​
gorgias_customers_update_customer_custom_field_values

Update customer fields values Parameters:
ParameterTypeRequiredDefaultDescription
customer_idintegerYes—The ID of the customer.
bodyobject[]Yes—Request body

​
gorgias_customers_update_customer_data

Set customer data Parameters:
ParameterTypeRequiredDefaultDescription
customer_idintegerYes—The ID of the customer to update.
dataobjectNo—The customer data.
versionstringNo—The date of the customer data. If we already have a more recent version, the request will be ignored.