Type alias EmailTemplateSchema

EmailTemplateSchema: {
    body_html: string;
    body_txt: string;
    created_by?: string;
    created_date: string;
    custom_args: string[];
    description?: string;
    for_account_recovery: boolean;
    for_new_users: boolean;
    from_address?: string;
    id: string;
    is_active: boolean;
    is_delete_protected: boolean;
    last_updated_by?: string;
    last_updated_date?: string;
    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 created_by?: string

    ID of the user who created the template

  • created_date: string

    Date and time the template was created

  • custom_args: string[]

    List of custom arguments on this template

  • Optional description?: string

    Description of the template

  • for_account_recovery: boolean

    If true, the template is used for forgot password emails

  • 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

  • id: string

    ID of the template

  • is_active: boolean

    If false, all template operations are disabled

  • is_delete_protected: boolean

    This must be set false before the template can be deleted

  • Optional last_updated_by?: string

    ID of the user who last updated the template

  • Optional last_updated_date?: string

    Date and time the template was last updated

  • locale: string

    Locale for the template

  • 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

  • tags: string[]

    List of tags on this template