Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / UpdateBrandStylePayload

Interface: UpdateBrandStylePayload

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:259

Payload for BrandStylesClient.update (PATCH — all fields optional).

Only the fields you include are changed.

Example ​

typescript
await client.brandStyles.update(brandStyleId, {
  name: 'Acme Brand v2',
  colours: [{ type: 'accent', hex: '#003399', brightness: 30 }],
});

Properties ​

colours? ​

optional colours?: BrandStyleColourEntry[] | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:264

description? ​

optional description?: string | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:261

domain? ​

optional domain?: string | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:262

fonts? ​

optional fonts?: BrandStyleFontEntry[] | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:266

images? ​

optional images?: BrandStyleImageEntry[] | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:267

isDefault? ​

optional isDefault?: boolean | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:263

optional links?: BrandStyleLinkEntry[] | null

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:265

name? ​

optional name?: string

Defined in: client/src/resources/brand-styles/brand-styles.types.ts:260