Update KObject (custom object) by ID

Updates an existing KObject (custom object) based on the unique ID.

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

Note

This endpoint is subject to "Object Rate Limiting", meaning that a single user is limited in how many updates they can make to a single KObject. To learn more, see Rate limiting.

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
Language
Authentication
Bearer
Click Try It! to start a request and see the response here!