Function createBrand

  • Creates a new brand.

    Parameters

    • body: {
          description?: string;
          favIcon?: BodyInit;
          logo?: BodyInit;
          name: string;
          styles?: BodyInit;
      }

      an object with the body content

      • Optionaldescription?: string

        Description of the brand.

      • OptionalfavIcon?: BodyInit

        The path and name of a properly formatted ICO file. Maximum size is 100 KB.

      • Optionallogo?: BodyInit

        The path and name of a JPG or PNG file that will be adjusted to fit in a 'box' measuring 109px in width and 62 px in height while maintaining aspect ratio. Maximum size of 300 KB, but smaller is recommended.

      • name: string

        Name of the brand.

      • Optionalstyles?: BodyInit

        The path and name of a JSON file to define brand style settings. Maximum size is 100 KB. This property is not currently operational.

    • Optionaloptions: ApiCallOptions

    Returns Promise<CreateBrandHttpResponse>

    CreateBrandHttpError