If true, custom email content will replace the default body of welcome emails
content
string
The HTML to use as custom content for welcome emails. Script elements and other potentially dangerous markup will be removed.
subject
string
The text to appear in the email subject line. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled.
header
string
The text to appear in the header line of the email body. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled.
query
HTTP Query
Expand HTTP Query definition...
send_test_welcome_email
boolean
If true a test email with the content from the request will be sent to the current user after saving
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[],[],null,["# Update Custom Welcome Email Content\n\nVersion 4.0.25.14 (latest)\n\nUpdate custom welcome email setting and values. Optionally send a test email with the new content to the currently logged in user.\n\nRequest\n-------\n\nPATCH /custom_welcome_email \nDatatype \nDescription \nRequest \nHTTP Request \nbody \nHTTP Body \nExpand HTTP Body definition... \nbody \n[CustomWelcomeEmail](/looker/docs/reference/looker-api/latest/types/CustomWelcomeEmail) \nCustom Welcome Email setting and value to save\nExpand CustomWelcomeEmail definition... \nenabled \nboolean \nIf true, custom email content will replace the default body of welcome emails \ncontent \nstring \nThe HTML to use as custom content for welcome emails. Script elements and other potentially dangerous markup will be removed. \nsubject \nstring \nThe text to appear in the email subject line. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled. \nheader \nstring \nThe text to appear in the header line of the email body. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled. \nquery \nHTTP Query \nExpand HTTP Query definition... \nsend_test_welcome_email \nboolean \nIf true a test email with the content from the request will be sent to the current user after saving\n\nResponse\n--------\n\n### 200: Custom Welcome Email\n\nDatatype \nDescription \n(object) \n[CustomWelcomeEmail](/looker/docs/reference/looker-api/latest/types/CustomWelcomeEmail) \nenabled \nboolean \nIf true, custom email content will replace the default body of welcome emails \ncontent \nstring \nThe HTML to use as custom content for welcome emails. Script elements and other potentially dangerous markup will be removed. \nsubject \nstring \nThe text to appear in the email subject line. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled. \nheader \nstring \nThe text to appear in the header line of the email body. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled.\n\n### 400: Bad Request\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 404: Not Found\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 422: Validation Error\n\nDatatype \nDescription \n(object) \n[ValidationError](/looker/docs/reference/looker-api/latest/types/ValidationError) \nmessage \n*lock* \nstring \nError details \nerrors \n[ValidationErrorDetail](/looker/docs/reference/looker-api/latest/types/ValidationErrorDetail)\\[\\] \nExpand ValidationErrorDetail definition... \nfield \n*lock* \nstring \nField with error \ncode \n*lock* \nstring \nError code \nmessage \n*lock* \nstring \nError info message \ndocumentation_url \n*lock* \nstring \nDocumentation link \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 429: Too Many Requests\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link"]]
