Sign in
KObjects (Custom Objects)

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
put/klasses/{name}/{id}

Request

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

Path parameters

namestring required
Example:orders

Klass name of the KObject.

idstring required
Example:5826ab180fcc2514008b2a94

Unique ID of the KObject.

Request body

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

Response

OK

Example response

{
  "data": {
    "attributes": {
      "firstDone": {
        "time": 27122,
        "businessTime": 27122,
        "createdAt": "2021-06-01T12:00:00Z",
        "createdBy": "60b6b1b3b3b3b3b3b3b3b3b3",
        "createdByTeam": "60b6b1b3b3b3b3b3b3b3b3b3",
        "assignedTeam": "60b6b1b3b3b3b3b3b3b3b3",
        "assignedUser": "60b6b1b3b3b3b3b3b3b3b3",
        "commentCount": 1
      },
      "lastDone": {
        "time": 27122,
        "businessTime": 27122,
        "createdAt": "2021-06-01T12:00:00Z",
        "createdBy": "60b6b1b3b3b3b3b3b3b3b3b3",
        "createdByTeam": "60b6b1b3b3b3b3b3b3b3b3b3",
        "assignedTeam": "60b6b1b3b3b3b3b3b3b3b3",
        "assignedUser": "60b6b1b3b3b3b3b3b3b3b3",
        "commentCount": 1
      },
      "queue": "60b6b1b3b3b3b3b3b3b3b3b3",
      "assignedUser": "60b6b1b3b3b3b3b3b3b3b3",
      "status": "open"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.