Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 1.51 KB

bulk-update-customers-request.md

File metadata and controls

43 lines (34 loc) · 1.51 KB
Raw

Bulk Update Customers Request

Defines the body parameters that can be included in requests to the BulkUpdateCustomers endpoint.

Structure

Bulk Update Customers Request

Fields

Name Type Tags Description
customers Dict Str Bulk Update Customer Data 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 (as JSON)

{
  "customers": {
    "8DDA5NZVBZFGAX0V3HPF81HHE0": {
      "email_address": "[email protected]",
      "note": "updated customer note",
      "phone_number": null,
      "version": 2,
      "given_name": "given_name4",
      "family_name": "family_name6",
      "company_name": "company_name8",
      "nickname": "nickname8"
    },
    "N18CPRVXR5214XPBBA6BZQWF3C": {
      "family_name": "Curie",
      "given_name": "Marie",
      "version": 0,
      "company_name": "company_name8",
      "nickname": "nickname8",
      "email_address": "email_address0"
    }
  }
}