Customers

Create customer

Creates a new customer record.

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

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

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
post/customers

Request

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

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

Created

Changes

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