Function createCompany

createCompany<ThrowOnError extends boolean = true>(
    options: Options<CreateCompanyData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                modifiedAt: string;
                name: string;
                tags: unknown[];
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                modifiedBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Create company Creates a new company.

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
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<CreateCompanyData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                modifiedAt: string;
                name: string;
                tags: unknown[];
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                createdBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                modifiedBy: {
                    data: { id: string; type: string };
                    links: { self: string };
                };
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:756

Function createCompany

Custom Attributes

Naming Suffix

Type Parameters

Parameters

Settings

On This Page