Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Update KObject

Updates an existing custom object.

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

|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.kobject.write|org.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. Please see the API Rate Limiting section of the documentation for additional details.

Custom Attibutes

Custom attributes are optional and allow you to specify custom key value pairs. They follow a convention which allows us to specify the field data type with a name suffix:

Suffix
  • Num or null
  • At or null
  • Str or null, length: [ 0 .. 1024 ] characters
  • Txt or null, length: [ 0 .. 1024 ] characters
  • Bool or null
  • Url or null, format:

Input

type: object properties: parameters: type: object properties: name: type: string description: (Required) Klass name of the KObject. id: type: string description: (Required) Unique ID of the KObject. required: - name - id title: Parameters data: type: string example: >- "{\n \"externalId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"images\": [\n \"<url>\"\n ],\n \"icon\": \"<string>\",\n \"data\": \"<object>\",\n \"custom\": \"<object>\",\n \"tags\": [\n \"<string>\"\n ],\n \"createdAt\": \"<dateTime>\",\n \"importedAt\": \"<dateTime>\",\n \"rev\": \"<number>\"\n}" title: Data

Output

type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: title: type: string description: type: string icon: type: string images: type: array items: type: string custom: type: object properties: orderUpdatedAt: type: string totalPriceNum: type: string orderDescriptionStr: type: string orderNumberNum: type: string specialInstructionsStr: type: string billingStatusStr: type: string shippingStatusStr: type: string orderStatusStr: type: string refundedBool: type: string tags: type: string updatedAt: type: string createdAt: type: string rev: type: string relationships: type: object properties: org: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string klass: type: object properties: link: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string