Customers

Update customer

Updates a customer based on the unique customer ID.

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

Legacy RoleEquivalent Permission Set Role
org.user.customer.writeorg.permission.customer.update

Note

This endpoint is subject to Object Rate Limiting, which limits how many updates single user can make to a single customer. To learn more, see Rate limiting.

Company

If you omit the company, the customer will no longer be linked to the company.

Custom Attributes

Custom attributes are optional and allow you to specify custom key-value pairs.

Kustomer uses a naming convention for custom attributes to specify the field data type with a name suffix:

Naming Suffix

  • Num number or null
  • At date-time or null
  • Str string or null, length: [ 0 .. 1024 ] characters
  • Txt string or null, length: [ 0 .. 1024 ] characters
  • Bool boolean or null
  • Url string or null, format: uri
put/customers/{id}

Request

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

Path parameters

idstring required
Example:58210c3db0f09110006b7953

Unique ID of the customer.

Query parameters

replaceboolean
Example:true

Set to true to update the document. Otherwise, performs the same update as a PATCH request. Default value: false.

Request body

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

OK

Changes

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