Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Customers

BulkUpdateCustomers

Updates multiple customer profiles.

This endpoint takes a map of individual update requests and returns a map of responses.

post/v2/customers/bulk-update

Request body

customersobject required

A map of 1 to 100 individual update requests, represented by customer ID: { customer data } key-value pairs.

Each key is the ID of the customer profile to update. To update a customer profile that was created by merging existing profiles, provide the ID of the newly created profile.

Each value contains the updated customer data. Only new or changed fields are required. To add or update a field, specify the new value. To remove a field, specify null.

Example request

{
  "customers": {
    "8DDA5NZVBZFGAX0V3HPF81HHE0": {
      "email_address": "New.Amelia.Earhart@example.com",
      "note": "updated customer note",
      "phone_number": null,
      "version": 2
    },
    "N18CPRVXR5214XPBBA6BZQWF3C": {
      "family_name": "Curie",
      "given_name": "Marie",
      "version": 0
    }
  }
}

Response

Success

responsesobject

A map of responses that correspond to individual update requests, represented by key-value pairs.

Each key is the customer ID that was specified for an update request and each value is the corresponding response. If the request succeeds, the value is the updated customer profile. If the request fails, the value contains any errors that occurred during the request.

Example response

{
  "responses": {
    "8DDA5NZVBZFGAX0V3HPF81HHE0": {
      "customer": {
        "birthday": "1897-07-24",
        "created_at": "2024-01-19T00:27:54.59Z",
        "creation_source": "THIRD_PARTY",
        "email_address": "New.Amelia.Earhart@example.com",
        "family_name": "Earhart",
        "given_name": "Amelia",
        "id": "8DDA5NZVBZFGAX0V3HPF81HHE0",
        "note": "updated customer note",
        "preferences": {
          "email_unsubscribed": false
        },
        "updated_at": "2024-01-19T00:38:06Z",
        "version": 3
      }
    },
    "N18CPRVXR5214XPBBA6BZQWF3C": {
      "customer": {
        "created_at": "2024-01-19T00:27:54.59Z",
        "creation_source": "THIRD_PARTY",
        "family_name": "Curie",
        "given_name": "Marie",
        "id": "N18CPRVXR5214XPBBA6BZQWF3C",
        "preferences": {
          "email_unsubscribed": false
        },
        "updated_at": "2024-01-19T00:38:06Z",
        "version": 1
      }
    }
  }
}