Function getDefaultBrand

getDefaultBrand<ThrowOnError extends boolean = true>(
    options: Options<GetDefaultBrandData, ThrowOnError>,
): RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                default: boolean;
                name: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
Get default brand Retrieves the default brand that was created for your Kustomer organization during registration.

Learn more about the default brand in the Kustomer Help Center.

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

Legacy Role Equivalent Permission Set Role

org.admin.brand.read org.permission.brand.read

org.user.brand.read
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDefaultBrandData, ThrowOnError>
Returns RequestResult<
    {
        data: {
            attributes: {
                createdAt: string;
                default: boolean;
                name: string;
                updatedAt: string;
            };
            id: string;
            links: { self: string };
            relationships: {
                org: { data: { id: string; type: string }; links: { self: string } };
            };
            type: string;
        };
    },
    unknown,
    ThrowOnError,
>
- Defined in src/api/sdk.gen.ts:519

Legacy Role	Equivalent Permission Set Role
org.admin.brand.read	org.permission.brand.read
org.user.brand.read

Function getDefaultBrand

Type Parameters

Parameters

Returns RequestResult< { data: { attributes: { createdAt: string; default: boolean; name: string; updatedAt: string; }; id: string; links: { self: string }; relationships: { org: { data: { id: string; type: string }; links: { self: string } }; }; type: string; }; }, unknown, ThrowOnError,>

Settings

Returns RequestResult<
{
data: {
attributes: {
createdAt: string;
default: boolean;
name: string;
updatedAt: string;
};
id: string;
links: { self: string };
relationships: {
org: { data: { id: string; type: string }; links: { self: string } };
};
type: string;
};
},
unknown,
ThrowOnError,
>