更新自定义欢迎电子邮件内容

版本 3.1.23.6

更新自定义欢迎电子邮件设置和值。（可选）向当前登录的用户发送包含新内容的测试电子邮件。

请求

PATCH /custom_welcome_email
数据类型
说明
请求
HTTP 请求
body
HTTP 正文
展开 HTTPBody 定义...
body
自定义欢迎电子邮件设置和值
展开 CustomWelcomeEmail 定义...
可以
对象
当前用户可以对此对象执行的操作
已启用
布尔值
如果值为 true，自定义电子邮件内容将取代默认的欢迎电子邮件正文
内容
字符串
用作欢迎电子邮件的自定义内容的 HTML。脚本元素和其他可能危险的标记将被移除。
subject
字符串
显示在电子邮件主题行中的文字。仅在启用白标签许可和 whitelabel_configuration.advanced_custom_welcome_email 时可用。
标头
字符串
显示在电子邮件正文的文本行中。仅在启用白标签许可和 whitelabel_configuration.advanced_custom_welcome_email 时可用。
查询
HTTPQuery
展开 HTTPQuery 定义...
send_test_welcome_email
布尔值
如果为 true，系统将会在保存后向当前用户发送包含请求内容的测试电子邮件

响应

200：自定义欢迎电子邮件

数据类型
说明
（对象）
可以
对象
当前用户可以对此对象执行的操作
已启用
布尔值
如果值为 true，自定义电子邮件内容将取代默认的欢迎电子邮件正文
内容
字符串
用作欢迎电子邮件的自定义内容的 HTML。脚本元素和其他可能危险的标记将被移除。
subject
字符串
显示在电子邮件主题行中的文字。仅在启用白标签许可和 whitelabel_configuration.advanced_custom_welcome_email 时可用。
标头
字符串
显示在电子邮件正文的文本行中。仅在启用白标签许可和 whitelabel_configuration.advanced_custom_welcome_email 时可用。

400：错误请求

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

404：未找到

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

422：验证错误

数据类型
说明
（对象）
消息
字符串
错误详情
展开 ValidationErrorDetail 定义...
字段
字符串
出错的字段
代码
字符串
错误代码
消息
字符串
错误信息消息
文档网址
字符串
文档链接
文档网址
字符串
文档链接

429：请求数过多

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接