KObjects (Custom Objects)

Create KObject

Creates a new KObject (custom object).

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

Legacy RoleEquivalent Permission Set Role
org.user.kobject.writeorg.permission.kobject.create
org.permission.kobject.kobject_*.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

Rate Limit

Custom objects are subject to a rate limit. A single client can create up to 120 custom objects per minute per customer.

Notes

  • Custom objects with importedAt in the body will not be subject to the rate limit.
  • A 429 Too Many Requests response will be returned if the rate limit has been reached for a customer.
post/klasses/{name}

Request

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

Request body

customerstring
companystring
externalIdstring
titlestring required
descriptionstring
imagesstring[]
iconstring
dataobject
customobject
tagsstring[]
createdAtstring date-time
importedAtstring date-time

Response

Created

Changes

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