kustomer-client
    Preparing search index...

    Function bulkBatchUpdateKObjects

    • Bulk batch update KObjects (custom objects) Updates a bulk batch of multiple KObjects (custom objects).

      Use the ids query param to update multiple KObjects in bulk with the same data.

      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

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      completed: boolean;
                      context: string;
                      createdAt: string;
                      ids: unknown[];
                      payload: {
                          api: {
                              data: { custom: { shippingStatusStr: string }; id: string }[];
                              method: string;
                              path: string;
                              requestId: string;
                              service: string;
                              user: {
                                  id: string;
                                  org: string;
                                  orgName: string;
                                  roles: string[];
                                  subject: string;
                                  userType: string;
                              };
                          };
                      };
                      status: string;
                      updatedAt: string;
                      v2: boolean;
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      createdBy: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility