Function updateKObject

updateKObject<ThrowOnError extends boolean = true>(
    options: Options<UpdateKObjectData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                assignedUser?: string;
                createdAt: string;
                custom: {
                    billingStatusStr: string;
                    orderDescriptionStr: string;
                    orderNumberNum: number;
                    orderStatusStr: string;
                    orderUpdatedAt: string;
                    refundedBool: boolean;
                    shippingStatusStr: string;
                    specialInstructionsStr: string;
                    totalPriceNum: number;
                };
                description: null
                | string;
                doneCount?: number;
                firstDone?: {
                    assignedTeam?: string;
                    assignedUser?: string;
                    businessTime?: number;
                    commentCount?: number;
                    createdAt?: string;
                    createdBy?: string;
                    createdByTeam?: string;
                    time?: number;
                };
                icon: string;
                images: string[];
                lastDone?: {
                    assignedTeam?: string;
                    assignedUser?: string;
                    businessTime?: number;
                    commentCount?: number;
                    createdAt?: string;
                    createdBy?: string;
                    createdByTeam?: string;
                    time?: number;
                };
                queue?: string;
                reopenCount?: number;
                reopenFromDoneCount?: number;
                rev: number;
                status?: "open"
                | "done";
                tags: unknown[];
                title: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                klass: { data: { id: string; type: string }; link: { self: string } };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
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 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. 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
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<UpdateKObjectData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                assignedUser?: string;
                createdAt: string;
                custom: {
                    billingStatusStr: string;
                    orderDescriptionStr: string;
                    orderNumberNum: number;
                    orderStatusStr: string;
                    orderUpdatedAt: string;
                    refundedBool: boolean;
                    shippingStatusStr: string;
                    specialInstructionsStr: string;
                    totalPriceNum: number;
                };
                description: null
                | string;
                doneCount?: number;
                firstDone?: {
                    assignedTeam?: string;
                    assignedUser?: string;
                    businessTime?: number;
                    commentCount?: number;
                    createdAt?: string;
                    createdBy?: string;
                    createdByTeam?: string;
                    time?: number;
                };
                icon: string;
                images: string[];
                lastDone?: {
                    assignedTeam?: string;
                    assignedUser?: string;
                    businessTime?: number;
                    commentCount?: number;
                    createdAt?: string;
                    createdBy?: string;
                    createdByTeam?: string;
                    time?: number;
                };
                queue?: string;
                reopenCount?: number;
                reopenFromDoneCount?: number;
                rev: number;
                status?: "open"
                | "done";
                tags: unknown[];
                title: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                klass: { data: { id: string; type: string }; link: { self: string } };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:3011

Function updateKObject

Note

Custom Attributes

Naming Suffix

Type Parameters

Parameters

Settings

On This Page

Legacy Role	Equivalent Permission Set Role
org.user.kobject.write	org.permission.kobject.update
	org.permission.kobject.kobject_*.update