kustomer-client
    Preparing search index...

    Function bulkCreateCompanies

    • Bulk create companies Creates companies in bulk.

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

      Legacy Role Equivalent Permission Set Role
      org.user.company.write org.permission.company.create

      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:

      • 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

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      completed: boolean;
                      context: string;
                      createdAt: string;
                      ids: unknown[];
                      payload: {
                          api: {
                              data: { name: 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

    On This Page

    Custom Attributes