KObjects (Custom Objects) (Bulk)

Bulk batch update KObjects (custom objects)

Updates a bulk batch of multiple KObjects (custom objects).

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

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

Legacy RoleEquivalent Permission Set Role
org.user.kobject.writeorg.permission.kobject.update
org.permission.kobject.kobject_*.update
put/klasses/{name}/bulk

Request

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

Path parameters

namestring required
Example:orders

Klass name of KObjects (custom objects).

Query parameters

idsstring
Example:id1,id2

Comma-separated list of unique KObject IDs.

Request body

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

Response

Success

Changes

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