Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Create KObject

Creates a new 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.create| ||org.permission.kobject.kobject_*.create|

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:

Rate Limit

Custom objects are subject to a rate limit. A single client can create up to 120 custom objects per minute per customer. Custom objects with importedAt in their 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.

Input

type: object properties: parameters: type: object properties: name: type: string description: (Required) Klass name of KObjects. required: - name title: Parameters data: type: string example: >- "{\n \"title\": \"<string>\",\n \"customer\": \"<string>\",\n \"company\": \"<string>\",\n \"externalId\": \"<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}" title: Data

Output

type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: title: type: string icon: type: string images: type: array items: type: string custom: type: object properties: orderStatusStr: type: string shippingStatusStr: type: string billingStatusStr: type: string specialInstructionsStr: type: string orderNumberNum: type: string orderDescriptionStr: type: string totalPriceNum: type: string orderUpdatedAt: 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