Merge Customers

Learn how to use the /api/v1/customers/{id}/merge/ API endpoint to merge one customer into another, provided you have the appropriate access permissions as a manager. This document outlines the HTTP POST method and the required request body parameter.

circle-info

Updates customer on all orders from the customer provided in request body (customer_to_merge_id) to the customer provided in request URL and deletes the customer provided in request body (customer_to_merge_id).

Endpoint

  • Method: POST

  • URL: /api/v1/customers/{id}/merge/

Request body example

Request body (application/json)
{
    "customer_to_merge_id": 1013240
}

Responses

200 OK
{
    "message": "Merged."
}
404 Not Found
{
  "message": "Ain't no cake like that."
}

Was this helpful?