Customers (Bulk)

Bulk batch update customers

Updates a bulk batch of customers.

Use the ids query param to update multiple customers in bulk with the same data.

Any one of the following roles is required for this endpoint:

Legacy RoleEquivalent Permission Set Role
org.user.customer.writeorg.permission.customer.update
put/customers/bulk

Request

  • Base URL: https://api.kustomerapp.com/v1
  • URL: https://api.kustomerapp.com/v1/customers/bulk
  • Auth: httpBearer (a scheme the document does not define)

Query parameters

idsstring
Example:id1,id2

Comma-separated list of unique customer IDs.

Request body

idstring required
namestring nullable
companystring nullable
externalIdstring nullable
usernamestring nullable
signedUpAtstring date-time nullable
lastActivityAtstring date-time nullable
lastCustomerActivityAtstring date-time nullable
lastSeenAtstring date-time nullable
avatarUrlstring uri nullable
localestring nullable
timeZonestring nullable
tagsstring[]
customobject
birthdayAtstring date-time nullable
gender'm' | 'f' nullable
createdAtstring date-time
importedAtstring date-time
revnumber
defaultLangstring nullable

Response

Created

Changes

No recorded changes to this operation across all 8 revisions of this API.