API Reference

Merge two customers

put
https://{domain}.gorgias.com/api/customers/merge

Merge two customers according to the data sent in the payload. The data of the source customer will be merged into the target customer and then deleted. In case both customers have data for the same integration a conflict will occur with the API returning an error.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required
≥ 1

The ID of the customer to merge (which will be merged into the targeted customer).

integer
required
≥ 1

The ID of the targeted customer (which will still be here after the merge).

Body Params

Data to update the target customer with (for example the target customer's new email address).

channels
array of objects

A list of CustomerChannel objects. Each channel represents a way to communicate with a customer. Example: email, phone, facebook, etc...

channels
null

The custom fields associated with the customer.

null
deprecated

User defined JSON field. It can be useful for storing additional info about the object. <span style={{color: 'red'}}>This parameter has been deprecated.

string | null

Primary email address of the customer

string | null

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.

integer

ID of the object

string | null

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

null

User defined JSON field. It can be useful for storing additional info about the object.

string | null

Full name of the customer

string | null

A note describing the customer.

string | null
Defaults to UTC

Timezone of the customer. We're using timezones defined on this list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Response

Updated 4 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago