Type alias CreateEmailTemplateBody

CreateEmailTemplateBody: {
    body_html: string;
    body_txt: string;
    custom_args?: string[];
    description?: string;
    for_account_recovery?: boolean;
    for_new_users?: boolean;
    from_address?: string;
    is_delete_protected?: boolean;
    locale?: string;
    name: string;
    project_id?: string;
    subject: string;
    tags?: string[];
}

Type declaration

  • body_html: string

    HTML body of the template

  • body_txt: string

    Plain text body of the template

  • Optional custom_args?: string[]

    List of custom arguments on this template

  • Optional description?: string

    Description of the template

  • Optional for_account_recovery?: boolean

    If true, the template is used for forgot password emails

  • Optional for_new_users?: boolean

    If true, the template is used for new user emails

  • Optional from_address?: string

    From email address to use with this template

  • Optional is_delete_protected?: boolean

    This must be set false before the template can be deleted

  • Optional locale?: string

    Locale for the template, defaults to project or org locale

  • name: string

    Name of the template

  • Optional project_id?: string

    ID of the project this template belongs to, if any

  • subject: string

    Subject of the template

  • Optional tags?: string[]

    List of tags on this template